2024-07-10 16:44:39 +00:00
|
|
|
# Bolt Monorepo
|
|
|
|
|
|
|
|
|
|
Welcome to the Bolt monorepo! This repository contains the codebase for Bolt, an AI assistant developed by StackBlitz.
|
|
|
|
|
|
|
|
|
|
## Repository Structure
|
|
|
|
|
|
|
|
|
|
Currently, this monorepo contains a single package:
|
|
|
|
|
|
|
|
|
|
- [`bolt`](packages/bolt): The main package containing the UI interface for Bolt as well as the server components.
|
|
|
|
|
|
|
|
|
|
As the project grows, additional packages may be added to this workspace.
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
2024-07-11 19:25:19 +00:00
|
|
|
- Node.js (v20.15.1)
|
2024-07-10 16:44:39 +00:00
|
|
|
- pnpm (v9.4.0)
|
|
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
1. Clone the repository:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/stackblitz/bolt.git
|
|
|
|
|
cd bolt
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Install dependencies:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
pnpm i
|
|
|
|
|
```
|
|
|
|
|
|
2024-07-29 18:31:45 +00:00
|
|
|
3. Optionally, init git hooks:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
pnpmx husky
|
|
|
|
|
```
|
|
|
|
|
|
2024-07-10 16:44:39 +00:00
|
|
|
### Development
|
|
|
|
|
|
|
|
|
|
To start developing the Bolt UI:
|
|
|
|
|
|
|
|
|
|
1. Navigate to the bolt package:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd packages/bolt
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Start the development server:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
pnpm run dev
|
|
|
|
|
```
|
