Skip to content

Latest commit

 

History

History
142 lines (98 loc) · 5.13 KB

README.md

File metadata and controls

142 lines (98 loc) · 5.13 KB
Raw
Srcbook banner

npm version Apache 2.0 license

Online app builder · Discord · Youtube · Hub

Srcbook

Srcbook is a TypeScript-centric app development platform, with 2 main products:

  • an AI app builder (also available hosted online)
  • a TypeScript notebook

Srcbook is open-source (apache2) and runs locally on your machine. You'll need to bring your own API key for AI usage (we strongly recommend Anthropic with claude-3-5-sonnet-latest).

Features

App Builder

  • AI app builder for TypeScript
  • Create, edit and run web apps
  • Use AI to generate the boilerplate, modify the code, and fix things
  • Edit the app with a hot-reloading web preview
Example Srcbook

Notebooks

  • Create, run, and share TypeScript notebooks
  • Export to valid markdown format (.src.md)
  • AI features for exploring and iterating on ideas
  • Diagraming with mermaid for rich annotations
  • Local execution with a web interface
  • Powered by Node.js
Example Srcbook

FAQ

See FAQ.

Getting Started

Srcbook runs locally on your machine as a CLI application with a web interface.

Requirements

  • Node 18+, we recommend using nvm to manage local node versions
  • corepack to manage package manager versions

Installing

We recommend using npx to always run the latest version from npm

# Using npm
npx srcbook@latest start

# Using your pm equivalent
pnpm dlx srcbook@latest start

You can instead use a global install with <pkg manager> i -g srcbook and then directly call srcbook with srcbook start

Using Docker

You can also run Srcbook using Docker:

# Build the Docker image
docker build -t srcbook .

# Run the container
# The -p flag maps port 2150 from the container to your host machine
# First -v flag mounts your local .srcbook directory to persist data
# Second -v flag shares your npm cache for better performance
docker run -p 2150:2150 -v ~/.srcbook:/root/.srcbook -v ~/.npm:/root/.npm srcbook

Make sure to set up your API key after starting the container. You can do this through the web interface at http://localhost:2150.

Current Commands

$ srcbook -h
Usage: srcbook [options] [command]

Srcbook is a interactive programming environment for TypeScript

Options:
  -V, --version                 output the version number
  -h, --help                    display help for command

Commands:
  start [options]               Start the Srcbook server
  import [options] <specifier>  Import a Notebook
  help [command]                display help for command

Uninstalling

You can remove srcbook by first removing the package, and then cleaning it's local directory on disk:

rm -rf ~/.srcbook

# if you configured a global install
npm uninstall -g srcbook

if you used another pm you will need to use it's specific uninstall command

Analytics and tracking

In order to improve Srcbook, we collect some behavioral analytics. We don't collect any Personal Identifiable Information (PII), our goals are simply to improve the application. The code is open source so you don't have to trust us, you can verify! You can find more information in our privacy policy.

If you want to disable tracking, you can run Srcbook with SRCBOOK_DISABLE_ANALYTICS=true set in the environment.

Contributing

For development instructions, see CONTRIBUTING.md.