Skip to content

Commit eeafc12

Browse files
doc: update README.md
Updated setup section Updated the Features sections Changed a few more Bolt.new to Bolt.diy
2 parents 4329e77 + ec4b43d commit eeafc12

File tree

1 file changed

+116
-125
lines changed

1 file changed

+116
-125
lines changed

README.md

Lines changed: 116 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Bolt.new: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.new)
1+
[![Bolt.diy: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.diy)
22

33
# Bolt.diy (Previously oTToDev)
44

@@ -56,176 +56,167 @@ https://thinktank.ottomator.ai
5656
- ⬜ Perplexity Integration
5757
- ⬜ Vertex AI Integration
5858

59-
## Bolt.new: AI-Powered Full-Stack Web Development in the Browser
59+
## Bolt.diy Features
6060

61-
Bolt.new (and by extension Bolt.diy) 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)
61+
- **AI-powered full-stack web development** directly in your browser.
62+
- **Support for multiple LLMs** with an extensible architecture to integrate additional models.
63+
- **Attach images to prompts** for better contextual understanding.
64+
- **Integrated terminal** to view output of LLM-run commands.
65+
- **Revert code to earlier versions** for easier debugging and quicker changes.
66+
- **Download projects as ZIP** for easy portability.
67+
- **Integration-ready Docker support** for a hassle-free setup.
6268

63-
## What Makes Bolt.new Different
69+
## Setup Bolt.diy
6470

65-
Claude, v0, etc are incredible- but you can't install packages, run backends, or edit code. That’s where Bolt.new stands out:
71+
If you're new to installing software from GitHub, don't worry! If you encounter any issues, feel free to submit an "issue" using the provided links or improve this documentation by forking the repository, editing the instructions, and submitting a pull request. The following instruction will help you get the stable branch up and running on your local machine in no time.
6672

67-
- **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:
68-
- Install and run npm tools and libraries (like Vite, Next.js, and more)
69-
- Run Node.js servers
70-
- Interact with third-party APIs
71-
- Deploy to production from chat
72-
- Share your work via a URL
73+
### Prerequisites
7374

74-
- **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 whole app lifecycle—from creation to deployment.
75+
1. **Install Git**: [Download Git](https://git-scm.com/downloads)
76+
2. **Install Node.js**: [Download Node.js](https://nodejs.org/en/download/)
7577

76-
Whether you’re an experienced developer, a PM, or a designer, Bolt.new allows you to easily build production-grade full-stack applications.
78+
- After installation, the Node.js path is usually added to your system automatically. To verify:
79+
- **Windows**: Search for "Edit the system environment variables," click "Environment Variables," and check if `Node.js` is in the `Path` variable.
80+
- **Mac/Linux**: Open a terminal and run:
81+
```bash
82+
echo $PATH
83+
```
84+
Look for `/usr/local/bin` in the output.
7785

78-
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
86+
### Clone the Repository
7987

80-
## Setup
88+
Clone the repository using Git:
8189

82-
Many of you are new users to installing software from Github. If you have any installation troubles reach out and submit an "issue" using the links above, or feel free to enhance this documentation by forking, editing the instructions, and doing a pull request.
90+
```bash
91+
git clone -b stable https://github.com/stackblitz-labs/bolt.diy
92+
```
8393

84-
1. Install Git from https://git-scm.com/downloads
94+
### (Optional) Configure Environment Variables
8595

86-
2. Install Node.js from https://nodejs.org/en/download/
96+
Most environment variables can be configured directly through the settings menu of the application. However, if you need to manually configure them:
8797

88-
Pay attention to the installer notes after completion.
98+
1. Rename `.env.example` to `.env.local`.
99+
2. Add your LLM API keys. For example:
89100

90-
On all operating systems, the path to Node.js should automatically be added to your system path. But you can check your path if you want to be sure. On Windows, you can search for "edit the system environment variables" in your system, select "Environment Variables..." once you are in the system properties, and then check for a path to Node in your "Path" system variable. On a Mac or Linux machine, it will tell you to check if /usr/local/bin is in your $PATH. To determine if usr/local/bin is included in $PATH open your Terminal and run:
101+
```env
102+
GROQ_API_KEY=YOUR_GROQ_API_KEY
103+
OPENAI_API_KEY=YOUR_OPENAI_API_KEY
104+
ANTHROPIC_API_KEY=YOUR_ANTHROPIC_API_KEY
105+
```
91106

92-
```
93-
echo $PATH .
94-
```
107+
**Note**: Ollama does not require an API key as it runs locally.
95108

96-
If you see usr/local/bin in the output then you're good to go.
109+
3. Optionally, set additional configurations:
97110

98-
3. Clone the repository (if you haven't already) by opening a Terminal window (or CMD with admin permissions) and then typing in this:
111+
```env
112+
# Debugging
113+
VITE_LOG_LEVEL=debug
99114
100-
```
101-
git clone https://github.com/stackblitz-labs/bolt.diy.git
102-
```
115+
# Ollama settings (example: 8K context, localhost port 11434)
116+
OLLAMA_API_BASE_URL=http://localhost:11434
117+
DEFAULT_NUM_CTX=8192
118+
```
103119

104-
3. Rename .env.example to .env.local and add your LLM API keys. You will find this file on a Mac at "[your name]/bold.new-any-llm/.env.example". For Windows and Linux the path will be similar.
120+
**Important**: Do not commit your `.env.local` file to version control. This file is already included in `.gitignore`.
105121

106-
![image](https://github.com/user-attachments/assets/7e6a532c-2268-401f-8310-e8d20c731328)
122+
---
107123

108-
If you can't see the file indicated above, its likely you can't view hidden files. On Mac, open a Terminal window and enter this command below. On Windows, you will see the hidden files option in File Explorer Settings. A quick Google search will help you if you are stuck here.
124+
## Run the Application
109125

110-
```
111-
defaults write com.apple.finder AppleShowAllFiles YES
112-
```
126+
### Option 1: Without Docker
113127

114-
**NOTE**: you only have to set the ones you want to use and Ollama doesn't need an API key because it runs locally on your computer:
128+
1. **Install Dependencies**:
129+
```bash
130+
pnpm install
131+
```
132+
If `pnpm` is not installed, install it using:
133+
```bash
134+
sudo npm install -g pnpm
135+
```
115136

116-
Get your GROQ API Key here: https://console.groq.com/keys
137+
2. **Start the Application**:
138+
```bash
139+
pnpm run dev
140+
```
141+
This will start the Remix Vite development server. You will need Google Chrome Canary to run this locally if you use Chrome! It's an easy install and a good browser for web development anyway.
117142
118-
Get your Open AI API Key by following these instructions: https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key
143+
### Option 2: With Docker
119144
120-
Get your Anthropic API Key in your account settings: https://console.anthropic.com/settings/keys
145+
#### Prerequisites
146+
- Ensure Git, Node.js, and Docker are installed: [Download Docker](https://www.docker.com/)
121147
122-
```
123-
GROQ_API_KEY=XXX
124-
OPENAI_API_KEY=XXX
125-
ANTHROPIC_API_KEY=XXX
126-
```
148+
#### Steps
127149
128-
Optionally, you can set the debug level:
150+
1. **Build the Docker Image**:
129151
130-
```
131-
VITE_LOG_LEVEL=debug
132-
```
152+
Use the provided NPM scripts:
153+
```bash
154+
npm run dockerbuild # Development build
155+
npm run dockerbuild:prod # Production build
156+
```
133157
134-
And if using Ollama set the DEFAULT_NUM_CTX, the example below uses 8K context and ollama running on localhost port 11434:
158+
Alternatively, use Docker commands directly:
159+
```bash
160+
docker build . --target bolt-ai-development # Development build
161+
docker build . --target bolt-ai-production # Production build
162+
```
135163
136-
```
137-
OLLAMA_API_BASE_URL=http://localhost:11434
138-
DEFAULT_NUM_CTX=8192
139-
```
164+
2. **Run the Container**:
165+
Use Docker Compose profiles to manage environments:
166+
```bash
167+
docker-compose --profile development up # Development
168+
docker-compose --profile production up # Production
169+
```
140170
141-
**Important**: Never commit your `.env.local` file to version control. It's already included in .gitignore.
171+
- With the development profile, changes to your code will automatically reflect in the running container (hot reloading).
142172
143-
## Run with Docker
173+
---
144174
145-
Prerequisites:
175+
### Update Your Local Version to the Latest
146176
147-
Git and Node.js as mentioned above, as well as Docker: https://www.docker.com/
177+
To keep your local version of Bolt.diy up to date with the latest changes, follow these steps for your operating system:
148178
149-
### 1a. Using Helper Scripts
179+
#### 1. **Navigate to your project folder**
180+
Navigate to the directory where you cloned the repository and open a terminal:
150181
151-
NPM scripts are provided for convenient building:
182+
#### 2. **Fetch the Latest Changes**
183+
Use Git to pull the latest changes from the main repository:
152184
153-
```bash
154-
# Development build
155-
npm run dockerbuild
185+
```bash
186+
git pull origin main
187+
```
156188
157-
# Production build
158-
npm run dockerbuild:prod
159-
```
189+
#### 3. **Update Dependencies**
190+
After pulling the latest changes, update the project dependencies by running the following command:
160191
161-
### 1b. Direct Docker Build Commands (alternative to using NPM scripts)
192+
```bash
193+
pnpm install
194+
```
162195
163-
You can use Docker's target feature to specify the build environment instead of using NPM scripts if you wish:
196+
#### 4. **Run the Application**
197+
Once the updates are complete, you can start the application again with:
164198
165-
```bash
166-
# Development build
167-
docker build . --target bolt-ai-development
199+
```bash
200+
pnpm run dev
201+
```
168202
169-
# Production build
170-
docker build . --target bolt-ai-production
171-
```
203+
This ensures that you're running the latest version of Bolt.diy and can take advantage of all the newest features and bug fixes.
172204

173-
### 2. Docker Compose with Profiles to Run the Container
205+
---
174206

175-
Use Docker Compose profiles to manage different environments:
207+
## Available Scripts
176208

177-
```bash
178-
# Development environment
179-
docker-compose --profile development up
209+
Here are the available commands for managing the application:
180210

181-
# Production environment
182-
docker-compose --profile production up
183-
```
184-
185-
When you run the Docker Compose command with the development profile, any changes you
186-
make on your machine to the code will automatically be reflected in the site running
187-
on the container (i.e. hot reloading still applies!).
188-
189-
## Run Without Docker
190-
191-
1. Install dependencies using Terminal (or CMD in Windows with admin permissions):
192-
193-
```
194-
pnpm install
195-
```
196-
197-
If you get an error saying "command not found: pnpm" or similar, then that means pnpm isn't installed. You can install it via this:
198-
199-
```
200-
sudo npm install -g pnpm
201-
```
202-
203-
2. Start the application with the command:
204-
205-
```bash
206-
pnpm run dev
207-
```
208-
## Available Scripts
209-
210-
- `pnpm run dev`: Starts the development server.
211-
- `pnpm run build`: Builds the project.
212-
- `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.
213-
- `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`.
214-
- `pnpm test`: Runs the test suite using Vitest.
215-
- `pnpm run typecheck`: Runs TypeScript type checking.
216-
- `pnpm run typegen`: Generates TypeScript types using Wrangler.
217-
- `pnpm run deploy`: Builds the project and deploys it to Cloudflare Pages.
218-
- `pnpm run lint:fix`: Runs the linter and automatically fixes issues according to your ESLint configuration.
219-
220-
## Development
221-
222-
To start the development server:
223-
224-
```bash
225-
pnpm run dev
226-
```
227-
228-
This will start the Remix Vite development server. You will need Google Chrome Canary to run this locally if you use Chrome! It's an easy install and a good browser for web development anyway.
211+
- `pnpm run dev`: Start the development server.
212+
- `pnpm run build`: Build the project.
213+
- `pnpm run start`: Run the built application locally (uses Wrangler Pages).
214+
- `pnpm run preview`: Build and start the application locally for production testing.
215+
- `pnpm test`: Run the test suite using Vitest.
216+
- `pnpm run typecheck`: Perform TypeScript type checking.
217+
- `pnpm run typegen`: Generate TypeScript types using Wrangler.
218+
- `pnpm run deploy`: Build and deploy the project to Cloudflare Pages.
219+
- `pnpm lint:fix`: Run the linter and automatically fix issues.
229220

230221
## How do I contribute to Bolt.diy?
231222

0 commit comments

Comments
 (0)