diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 63045efae..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug Report -about: Something not working? Let us know! -title: '' -labels: 'Status: Triage, Type: Bug' -assignees: '' - ---- - -### **Description of Bug** -Provide a concise description of your bug and your project link (if applicable). - - -### **Steps to Reproduce** - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - - -### **Expected Behavior** -A clear and concise description of what you expected to happen. - - -### **Screenshots/Screencast** -If applicable, add screenshots to help explain your problem. - - -**Additional Context/Questions** -Add any other context or questions regarding this bug. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..a594bc872 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: "Bug report" +description: Create a report to help us improve +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue :pray:. + + This issue tracker is for bugs and issues found with [Bolt.new](https://bolt.new). + If you experience issues related to WebContainer, please file an issue in our [WebContainer repo](https://github.com/stackblitz/webcontainer-core), or file an issue in our [StackBlitz core repo](https://github.com/stackblitz/core) for issues with StackBlitz. + + The more information you fill in, the better we can help you. + - type: textarea + id: description + attributes: + label: Describe the bug + description: Provide a clear and concise description of what you're running into. + validations: + required: true + - type: input + id: link + attributes: + label: Link to the Bolt URL that caused the error + description: Please do not delete it after reporting! + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Describe the steps we have to take to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: Provide a clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screen Recording / Screenshot + description: If applicable, **please include a screen recording** (preferably) or screenshot showcasing the issue. This will assist us in resolving your issue quickly. + - type: textarea + id: platform + attributes: + label: Platform + value: | + - OS: [e.g. macOS, Windows, Linux] + - Browser: [e.g. Chrome, Safari, Firefox] + - Version: [e.g. 91.1] + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..33bae8c9c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,110 @@ +[![Bolt Open Source Codebase](./public/social_preview_index.jpg)](https://bolt.new) + +> Welcome to the **Bolt** open-source codebase! This repo cpontains a simple example app using the core components from bolt.new to help you get started building **AI-powered software development tools** powered by StackBlitz’s **WebContainer API**. + +### Why Build with Bolt + WebContainer API + +By building with the Bolt + WebContainer API you can create browser-based applications that let users **prompt, run, edit, and deploy** full-stack web apps directly in the browser, without the need for virtual machines. With WebContainer API, you can build apps that give AI direct access and full control over a **Node.js server**, **filesystem**, **package manager** and **dev terminal** inside your users browser tab. This powerful combination allows you to create a new class of development tools that support all major javascript libraries and node packages right out of the box, all without remote environments or local installs. + +### What’s the Difference Between Bolt (This Repo) and [Bolt.new](https://bolt.new)? + +- **Bolt.new**: This is the **commercial product** from StackBlitz—a hosted, browser-based AI development tool that enables users to prompt, run, edit, and deploy full-stack web applications directly in the browser. Built on top of the [Bolt open-source repo](https://github.com/stackblitz/bolt.new) and powered by the StackBlitz **WebContainer API**. + +- **Bolt (This Repo)**: This open-source repository provides the core components used to make **Bolt.new**. This repo contains the UI interface for Bolt as well as the server components, built using [Remix Run](https://remix.run/). By leveraging this repo and StackBlitz’s **WebContainer API**, you can create your own AI-powered development tools and full-stack applications that run entirely in the browser. + +# Get Started Building with Bolt + +Bolt combines the capabilities of AI with sandboxed development environments to create a collaborative experience where code can be developed by the assistant and the programmer together. Bolt combines [WebContainer API](https://webcontainers.io/api) with [Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet) using [Remix](https://remix.run/) and the [AI SDK](https://sdk.vercel.ai/). + +### WebContainer API + +Bolt uses [WebContainers](https://webcontainers.io/) to run generated code in the browser. WebContainers provide Bolt with a full-stack sandbox environment using [WebContainer API](https://webcontainers.io/api). WebContainers run full-stack applications directly in the browser without the cost and security concerns of cloud hosted AI agents. WebContainers are interactive and editable, and enables Bolt's AI to run code and understand any changes from the user. + +The [WebContainer API](https://webcontainers.io) is free for personal and open source usage. If you're building an application for commercial usage, you can learn more about our [WebContainer API commercial usage pricing here](https://stackblitz.com/pricing#webcontainer-api). + +### Remix App + +Bolt is built with [Remix](https://remix.run/) and +deployed using [CloudFlare Pages](https://pages.cloudflare.com/) and +[CloudFlare Workers](https://workers.cloudflare.com/). + +### AI SDK Integration + +Bolt uses the [AI SDK](https://github.com/vercel/ai) to integrate with AI +models. At this time, Bolt supports using Anthropic's Claude Sonnet 3.5. +You can get an API key from the [Anthropic API Console](https://console.anthropic.com/) to use with Bolt. +Take a look at how [Bolt uses the AI SDK](https://github.com/stackblitz/bolt.new/tree/main/app/lib/.server/llm) + +## Prerequisites + +Before you begin, ensure you have the following installed: + +- Node.js (v20.15.1) +- pnpm (v9.4.0) + +## Setup + +1. Clone the repository (if you haven't already): + +```bash +git clone https://github.com/stackblitz/bolt.new.git +``` + +2. Install dependencies: + +```bash +pnpm install +``` + +3. Create a `.env.local` file in the root directory and add your Anthropic API key: + +``` +ANTHROPIC_API_KEY=XXX +``` + +Optionally, you can set the debug level: + +``` +VITE_LOG_LEVEL=debug +``` + +**Important**: Never commit your `.env.local` file to version control. It's already included in .gitignore. + +## Available Scripts + +- `pnpm run dev`: Starts the development server. +- `pnpm run build`: Builds the project. +- `pnpm run start`: Runs the built application locally using Wrangler Pages. This script uses `bindings.sh` to set up necessary bindings so you don't have to duplicate environment variables. +- `pnpm run preview`: Builds the project and then starts it locally, useful for testing the production build. Note, HTTP streaming currently doesn't work as expected with `wrangler pages dev`. +- `pnpm test:` Runs the test suite using Vitest. +- `pnpm run typecheck`: Runs TypeScript type checking. +- `pnpm run typegen`: Generates TypeScript types using Wrangler. +- `pnpm run deploy`: Builds the project and deploys it to Cloudflare Pages. + +## Development + +To start the development server: + +```bash +pnpm run dev +``` + +This will start the Remix Vite development server. + +## Testing + +Run the test suite with: + +```bash +pnpm test +``` + +## Deployment + +To deploy the application to Cloudflare Pages: + +```bash +pnpm run deploy +``` + +Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account. diff --git a/README.md b/README.md index 29ed4a841..8a197b7fa 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,54 @@ -# Bolt -Welcome to the **Bolt** open-source repository! This repo provides everything you need to start building **AI-powered software development tools** powered by StackBlitz’s **WebContainer API**. +[![Bolt.new: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.new) -### Why Build with Bolt + WebContainer API -By building with the Bolt + WebContainer API you can create browser-based applications that let users **prompt, run, edit, and deploy** full-stack web apps directly in the browser, without the need for virtual machines. With WebContainer API, you can build apps that give AI direct access and full control over a **Node.js server**, **filesystem**, **package manager** and **dev terminal** inside your users browser tab. This powerful combination allows you to create a new class of development tools that support all major javascript libraries and node packages right out of the box, all without remote environments or local installs. +# Bolt.new: AI-Powered Full-Stack Web Development in the Browser +Bolt.new is an AI-powered web development agent that allows you to prompt, run, edit, and deploy full-stack applications directly from your browser—no local setup required. If you're here to build your own AI powered web dev agent using the Bolt open source codebase, [click here to get started!](./CONTRIBUTING.md) -### What’s the Difference Between Bolt (This Repo) and [Bolt.new](https://bolt.new)? +## What Makes Bolt.new Different -- **Bolt.new**: This is the **commercial product** from StackBlitz—a hosted, browser-based AI development tool that enables users to prompt, run, edit, and deploy full-stack web applications directly in the browser. Built on top of the [Bolt open-source repo](https://github.com/stackblitz/bolt) and powered by the StackBlitz **WebContainer API**, it offers non-technical users the ability to create production-grade apps using AI. +Claude, v0, etc are incredible- but you can't install packages, run backends or edit code. That’s where Bolt.new stands out: -- **Bolt (This Repo)**: This open-source repository provides the building blocks behind **Bolt.new**. This package contains the UI interface for Bolt as well as the server components, built using [Remix Run](https://remix.run/). By leveraging this repo and StackBlitz’s **WebContainer API**, you can create your own AI-powered development tools and full-stack applications that run entirely in the browser. This code allows you to customize and expand use cases, integrating AI and WebContainers into your own unique applications. +- **Full-Stack in the Browser**: Bolt.new integrates cutting-edge AI models with an in-browser development environment powered by **StackBlitz’s WebContainers**. This allows you to: + - Install and run npm tools and libraries (like Vite, Next.js, and more) + - Run Node.js servers + - Interact with 3rd party APIs + - Deploy to production from chat + - Share your work via a URL -The [WebContainer API](https://webcontainers.io) is free for personal and open source usage. If you're building an application for commercial usage, you can learn more about our [WebContainer API commercial usage pricing here](https://stackblitz.com/pricing#webcontainer-api). +- **AI with Environment Control**: Unlike traditional dev environments where the AI can only assist in code generation, Bolt.new gives AI models **complete control** over the entire environment including the filesystem, node server, package manager, terminal, and browser console. This empowers AI agents to handle the entire app lifecycle—from creation to deployment. -# Get Started Building with Bolt +Whether you’re an experienced developer, a PM or designer, Bolt.new allows you to build production-grade full-stack applications with ease. -## Prerequisites +For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo! -Before you begin, ensure you have the following installed: +## Tips and Tricks -- Node.js (v20.15.1) -- pnpm (v9.4.0) +Here are some tips to get the most out of Bolt.new: -## Setup +- **Be specific about your stack**: If you want to use specific frameworks or libraries (like Astro, Tailwind, ShadCN, or any other popular Javacsript framework), mention them in your initial prompt to ensure Bolt scaffolds the project accordingly. -1. Clone the repository (if you haven't already): +- **Use the enhance prompt icon**: Before sending your prompt, try clicking the 'enhance' icon to have the AI model help you refine your prompt, then edit the results before submitting. -```bash -git clone https://github.com/stackblitz/bolt.new.git -``` +- **Scaffold the basics first, then add features**: Make sure the basic structure of your application is in place before diving into more advanced functionality. This helps Bolt understand the foundation of your project and ensure everything is wired upu right before building out more advanced functionality. -2. Install dependencies: +- **Batch simple instructions**: Save time by combining simple instructions into one message. For example, you can ask Bolt to change the color scheme, add mobile responsiveness, and restart the dev server, all in one go saving you time and reducing API credit consumption significantly. -```bash -pnpm install -``` +## FAQs -3. Create a `.env.local` file in the root directory and add your Anthropic API key: +**Where do sign up for a paid plan?** +Bolt.new is free to get started. If you need more AI tokens or want private projects, you can purchase a paid subscription in your [Bolt.new](https://bolt.new) settings, in the lower left hand corner of the application. -``` -ANTHROPIC_API_KEY=XXX -``` +**What happens if I hit the free usage limit?** +Once your free daily token limit is reached, AI interactions are paused until the next day or until you upgrade your plan. -Optionally, you an set the debug level: +**Is Bolt in beta?** +Yes, Bolt.new is in beta, and we are actively improving it based on feedback. -``` -VITE_LOG_LEVEL=debug -``` +**How can I report Bolt.new issues?** +Check out the [Issues section](https://github.com/bolt.new/issues) to report an issue or request a new feature. Please use the search feature to check if someone else has already submitted the same issue/request. -**Important**: Never commit your `.env.local` file to version control. It's already included in .gitignore. +**What frameworks/libraries currently work on Bolt?** +Bolt.new supports most popular javascript frameworks and libraries. If it runs on StackBlitz, it will run on Bolt.new as well. -## Available Scripts - -- `pnpm run dev`: Starts the development server. -- `pnpm run build`: Builds the project. -- `pnpm run start`: Runs the built application locally using Wrangler Pages. This script uses `bindings.sh` to set up necessary bindings so you don't have to duplicate environment variables. -- `pnpm run preview`: Builds the project and then starts it locally, useful for testing the production build. Note, HTTP streaming currently doesn't work as expected with `wrangler pages dev`. -- `pnpm test:` Runs the test suite using Vitest. -- `pnpm run typecheck`: Runs TypeScript type checking. -- `pnpm run typegen`: Generates TypeScript types using Wrangler. -- `pnpm run deploy`: Builds the project and deploys it to Cloudflare Pages. - -## Development - -To start the development server: - -```bash -pnpm run dev -``` - -This will start the Remix Vite development server. - -## Testing - -Run the test suite with: - -```bash -pnpm test -``` - -## Deployment - -To deploy the application to Cloudflare Pages: - -```bash -pnpm run deploy -``` - -Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account. +**How can I add make sure my framework/project works well in bolt?** +We are excited to work with the javascript ecosystem to improve functionality in Bolt. Reach out to us via [hello@stackblitz.com](mailto:hello@stackblitz.com) to discuss how we can partner! diff --git a/app/entry.client.tsx b/app/entry.client.tsx index f95b51d43..62917e70d 100644 --- a/app/entry.client.tsx +++ b/app/entry.client.tsx @@ -3,5 +3,5 @@ import { startTransition } from 'react'; import { hydrateRoot } from 'react-dom/client'; startTransition(() => { - hydrateRoot(document, ); + hydrateRoot(document.getElementById('root')!, ); }); diff --git a/app/entry.server.tsx b/app/entry.server.tsx index de1998240..4baf07001 100644 --- a/app/entry.server.tsx +++ b/app/entry.server.tsx @@ -2,6 +2,9 @@ import type { AppLoadContext, EntryContext } from '@remix-run/cloudflare'; import { RemixServer } from '@remix-run/react'; import { isbot } from 'isbot'; import { renderToReadableStream } from 'react-dom/server'; +import { renderHeadToString } from 'remix-island'; +import { Head } from './root'; +import { themeStore } from '~/lib/stores/theme'; export default async function handleRequest( request: Request, @@ -10,7 +13,7 @@ export default async function handleRequest( remixContext: EntryContext, _loadContext: AppLoadContext, ) { - const body = await renderToReadableStream(, { + const readable = await renderToReadableStream(, { signal: request.signal, onError(error: unknown) { console.error(error); @@ -18,8 +21,49 @@ export default async function handleRequest( }, }); + const body = new ReadableStream({ + start(controller) { + const head = renderHeadToString({ request, remixContext, Head }); + + controller.enqueue( + new Uint8Array( + new TextEncoder().encode( + `${head}
`, + ), + ), + ); + + const reader = readable.getReader(); + + function read() { + reader + .read() + .then(({ done, value }) => { + if (done) { + controller.enqueue(new Uint8Array(new TextEncoder().encode(`
`))); + controller.close(); + + return; + } + + controller.enqueue(value); + read(); + }) + .catch((error) => { + controller.error(error); + readable.cancel(); + }); + } + read(); + }, + + cancel() { + readable.cancel(); + }, + }); + if (isbot(request.headers.get('user-agent') || '')) { - await body.allReady; + await readable.allReady; } responseHeaders.set('Content-Type', 'text/html'); diff --git a/app/root.tsx b/app/root.tsx index c122bf6f4..31eb387e0 100644 --- a/app/root.tsx +++ b/app/root.tsx @@ -4,6 +4,8 @@ import { Links, Meta, Outlet, Scripts, ScrollRestoration } from '@remix-run/reac import tailwindReset from '@unocss/reset/tailwind-compat.css?url'; import { themeStore } from './lib/stores/theme'; import { stripIndents } from './utils/stripIndent'; +import { createHead } from 'remix-island'; +import { useEffect } from 'react'; import reactToastifyStyles from 'react-toastify/dist/ReactToastify.css?url'; import globalStyles from './styles/index.scss?url'; @@ -50,24 +52,29 @@ const inlineThemeCode = stripIndents` } `; +export const Head = createHead(() => ( + <> + + + + +