Skip to content

Latest commit

 

History

History
221 lines (161 loc) · 6.54 KB

README.md

File metadata and controls

221 lines (161 loc) · 6.54 KB

Contributors Forks Stargazers Issues Apache 2.0 License

typerion

  • npm version

typerion-cli

  • npm version

Logo

Typerion

A Typescript notebook for developing, prototyping, and sharing software.
Explore the docs »

Web App · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments
  8. License

About The Project

Typerion Screen Capture

This is an interactive TypeScript notebook that can be used to develop, prototype, and share software. Typerion is entirely open-source, with a focus on low-barrier-to-use and ease-of-sharing results with other developers.

The Typerion notebook:

  • Has a rich code editor with syntax highlighting.
  • Supports dynamically importing modules that are loaded from https://unpkg.com/.
  • Allows passing context forward between code cells.
  • Provides saving and loading behavior so that results can be persisted and shared.

(back to top)

Getting Started

Quick Start

A local instance of Typerion can be started with npx:

npx typerion-cli

Pre-Requisites

  1. Install pnpm
  2. Install turborepo
pnpm install turbo --global

Install and Run

  1. Clone the repo 
    git clone https://github.com/Vilos92/typerion.git
  2. Install packages 
    pnpm install
  3. Run in development mode 
    turbo run dev

After the last command, the Typerion app can be accessed at http://localhost:5173/

Usage

The Notebook header contains controls to:

  • Create cells above and below the current cell.
  • Run all cells in the Notebook.
  • Save the current Notebook state to a file.
  • Load the Notebook state from a file.

Some keyboard shortcuts include:

  • CMD + Enter
    • Run the currently focused cell.
  • Shift + Enter
    • Run the currently focused cell, and then move to the next cell.
    • If the last cell is currently selected, a new cell is created.
  • CMD + Up / Down
    • Move focus up and down the cells in the Notebook.

(back to top)

Roadmap

  • Improved README.
  • Better dynamic imports of packages.
  • Simpler passing of global context between cells.
  • Improved output logging for cells.
  • Web application hosted on typerion.dev
  • The ability for each cell to interact with its own DOM.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are greatly appreciated. This project is intended to be fully open-source, and the support and feedback from other developers are fully welcome.

(back to top)

Contact

Gregory Linscheid - Website - [email protected]

Project Link: https://github.com/Vilos92/typerion

(back to top)

Acknowledgments

  • Byron Barmby - Design contributions for the logo.

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)