Bolt

Bolt is an AI assistant developed by StackBlitz. This package contains the UI interface for Bolt as well as the server components, built using Remix Run.

Prerequisites

Before you begin, ensure you have the following installed:

Node.js (v20.15.1)
pnpm (v9.4.0)

Setup

Clone the repository (if you haven't already):

git clone https://github.com/stackblitz/bolt.git
cd bolt

Install dependencies:

pnpm install

Create a .env.local file in the root of the bolt package directory and add your Anthropic API key:

ANTHROPIC_API_KEY=XXX

Optionally, you an set the debug level:

VITE_LOG_LEVEL=debug

If you want to run authentication against a local StackBlitz instance, add:

VITE_CLIENT_ORIGIN=https://local.stackblitz.com:3000

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:

pnpm run dev

This will start the Remix Vite development server.

Testing

Run the test suite with:

pnpm test

Deployment

To deploy the application to Cloudflare Pages:

pnpm run deploy

Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.

2.0 KiB Raw Blame History