{"id":14260709,"url":"https://github.com/srcbookdev/srcbook","last_synced_at":"2025-05-13T23:09:17.830Z","repository":{"id":246865652,"uuid":"797944032","full_name":"srcbookdev/srcbook","owner":"srcbookdev","description":"TypeScript-centric app development platform: notebook and AI app builder","archived":false,"fork":false,"pushed_at":"2025-03-28T20:18:37.000Z","size":2278,"stargazers_count":3297,"open_issues_count":32,"forks_count":281,"subscribers_count":32,"default_branch":"main","last_synced_at":"2025-04-10T22:15:28.922Z","etag":null,"topics":["ai","javascript","local","notebook","typescript"],"latest_commit_sha":null,"homepage":"https://srcbook.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/srcbookdev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-08T19:28:00.000Z","updated_at":"2025-04-10T03:13:09.000Z","dependencies_parsed_at":"2024-07-22T20:56:10.132Z","dependency_job_id":"6bfcdec4-e305-46d8-8c82-f405a05b54e5","html_url":"https://github.com/srcbookdev/srcbook","commit_stats":{"total_commits":578,"total_committers":16,"mean_commits":36.125,"dds":0.5449826989619377,"last_synced_commit":"36913a48addbebf2ca5c8393a72d016d4dc234af"},"previous_names":["srcbookdev/srcbook"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srcbookdev%2Fsrcbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srcbookdev%2Fsrcbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srcbookdev%2Fsrcbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srcbookdev%2Fsrcbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/srcbookdev","download_url":"https://codeload.github.com/srcbookdev/srcbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254042045,"owners_count":22004835,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","javascript","local","notebook","typescript"],"created_at":"2024-08-22T12:01:19.311Z","updated_at":"2025-05-13T23:09:12.796Z","avatar_url":"https://github.com/srcbookdev.png","language":"TypeScript","readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/2d5c9dda-044b-49e2-5255-4a0be1085d00/public\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/064ebb1f-5153-4581-badd-42b42272fc00/public\"\u003e\n  \u003cimg alt=\"Srcbook banner\" src=\"https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/064ebb1f-5153-4581-badd-42b42272fc00/public\"\u003e\n\u003c/picture\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://badge.fury.io/js/srcbook\"\u003e\u003cimg src=\"https://badge.fury.io/js/srcbook.svg\" alt=\"npm version\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" alt=\"Apache 2.0 license\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://srcbook.com\"\u003eOnline app builder\u003c/a\u003e ·\n  \u003ca href=\"https://discord.gg/shDEGBSe2d\"\u003eDiscord\u003c/a\u003e ·\n  \u003ca href=\"https://www.youtube.com/@srcbook\"\u003eYoutube\u003c/a\u003e ·\n  \u003ca href=\"https://hub.srcbook.com\"\u003eHub\u003c/a\u003e \n\u003c/p\u003e\n\n## Srcbook\n\nSrcbook is a TypeScript-centric app development platform, with 2 main products:\n\n- an AI app builder (also available [hosted online](https://srcbook.com/))\n- a TypeScript notebook\n\nSrcbook 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`).\n\n## Features\n\n### App Builder\n\n- AI app builder for TypeScript\n- Create, edit and run web apps\n- Use AI to generate the boilerplate, modify the code, and fix things\n- Edit the app with a hot-reloading web preview\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://i.imgur.com/lLJPZOs.png\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://i.imgur.com/k4xAyCQ.png\"\u003e\n  \u003cimg alt=\"Example Srcbook\" src=\"https://i.imgur.com/k4xAyCQ.png\"\u003e\n\u003c/picture\u003e\n\n### Notebooks\n\n- Create, run, and share TypeScript notebooks\n- Export to valid markdown format (.src.md)\n- AI features for exploring and iterating on ideas\n- Diagraming with [mermaid](https://mermaid.js.org) for rich annotations\n- Local execution with a web interface\n- Powered by Node.js\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/2a4fa0f6-ef1b-4606-c9fa-b31d61b7c300/public\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public\"\u003e\n  \u003cimg alt=\"Example Srcbook\" src=\"https://imagedelivery.net/oEu9i3VEvGGhcGGAYXSBLQ/ebfa2bfe-f805-4398-a348-0f48d4f93400/public\"\u003e\n\u003c/picture\u003e\n\n## FAQ\n\nSee [FAQ](https://github.com/srcbookdev/srcbook/blob/main/FAQ.md).\n\n## Getting Started\n\nSrcbook runs locally on your machine as a CLI application with a web interface.\n\n### Requirements\n\n- Node 18+, we recommend using [nvm](https://github.com/nvm-sh/nvm) to manage local node versions\n- [corepack](https://nodejs.org/api/corepack.html) to manage package manager versions\n\n### Installing\n\nWe recommend using npx to always run the latest version from npm\n\n```bash\n# Using npm\nnpx srcbook@latest start\n\n# Using your pm equivalent\npnpm dlx srcbook@latest start\n```\n\n\u003e You can instead use a global install with `\u003cpkg manager\u003e i -g srcbook`\n\u003e and then directly call srcbook with `srcbook start`\n\n### Using Docker\n\nYou can also run Srcbook using Docker:\n\n```bash\n# Build the Docker image\ndocker build -t srcbook .\n\n# Run the container\n# The -p flag maps port 2150 from the container to your host machine\n# First -v flag mounts your local .srcbook directory to persist data\n# Second -v flag shares your npm cache for better performance\ndocker run -p 2150:2150 -v ~/.srcbook:/root/.srcbook -v ~/.npm:/root/.npm srcbook\n```\n\nMake sure to set up your API key after starting the container. You can do this through the web interface at `http://localhost:2150`.\n\n### Current Commands\n\n```bash\n$ srcbook -h\nUsage: srcbook [options] [command]\n\nSrcbook is a interactive programming environment for TypeScript\n\nOptions:\n  -V, --version                 output the version number\n  -h, --help                    display help for command\n\nCommands:\n  start [options]               Start the Srcbook server\n  import [options] \u003cspecifier\u003e  Import a Notebook\n  help [command]                display help for command\n```\n\n### Uninstalling\n\nYou can remove srcbook by first removing the package, and then cleaning it's local directory on disk:\n\n```bash\nrm -rf ~/.srcbook\n\n# if you configured a global install\nnpm uninstall -g srcbook\n```\n\n\u003e if you used another pm you will need to use it's specific uninstall command\n\n## Analytics and tracking\n\nIn 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](https://github.com/srcbookdev/srcbook/blob/main/PRIVACY-POLICY.md).\n\nIf you want to disable tracking, you can run Srcbook with `SRCBOOK_DISABLE_ANALYTICS=true` set in the environment.\n\n## Contributing\n\nFor development instructions, see [CONTRIBUTING.md](https://github.com/srcbookdev/srcbook/blob/main/CONTRIBUTING.md).\n","funding_links":[],"categories":["TypeScript","Web-Based Tools","ai","Generators","Tools \u0026 Resources"],"sub_categories":["CLI Utilities","App"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrcbookdev%2Fsrcbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrcbookdev%2Fsrcbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrcbookdev%2Fsrcbook/lists"}