mirror of
https://github.com/stackblitz/bolt.new
synced 2024-11-27 22:42:21 +00:00
79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
|
# 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](https://remix.run/).
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
Before you begin, ensure you have the following installed:
|
||
|
|
|
||
|
|
- Node.js (v18.20.3)
|
||
|
|
- pnpm (v9.4.0)
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
1. Clone the repository (if you haven't already):
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/stackblitz/bolt.git
|
||
|
|
cd bolt
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Install dependencies:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm install
|
||
|
|
```
|
||
|
|
|
||
|
|
3. 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
|
||
|
|
```
|
||
|
|
|
||
|
|
**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.
|