Repository files navigation

Online app builder ·Discord ·Youtube ·Hub

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

• an AI app builder (also availablehosted 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 withclaude-3-5-sonnet-latest).

• 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

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

SeeFAQ.

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

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

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

# Using npmnpx srcbook@latest start# Using your pm equivalentpnpm dlx srcbook@latest start

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

You can also run Srcbook using Docker:

# Build the Docker imagedocker 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 performancedocker 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 athttp://localhost:2150.

$ srcbook -hUsage: srcbook [options] [command]Srcbook is a interactive programming environmentfor TypeScriptOptions:  -V, --version                 output the version number  -h, --help                    displayhelpforcommandCommands:  start [options]               Start the Srcbook server  import [options]<specifier>  Import a Notebookhelp [command]                displayhelpforcommand

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 installnpm uninstall -g srcbook

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

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 ourprivacy policy.

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

For development instructions, seeCONTRIBUTING.md.