doc: update README.md
Browse filesUpdated setup section
Updated the Features sections
Changed a few more Bolt.new to Bolt.diy
README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
-
[](https://bolt.diy)
|
| 2 |
|
| 3 |
# Bolt.diy (Previously oTToDev)
|
| 4 |
|
|
|
|
| 56 |
- ⬜ Perplexity Integration
|
| 57 |
- ⬜ Vertex AI Integration
|
| 58 |
|
| 59 |
+
## Bolt.diy Features
|
| 60 |
|
| 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.
|
| 68 |
|
| 69 |
+
## Setup Bolt.diy
|
| 70 |
|
| 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.
|
| 72 |
|
| 73 |
+
### Prerequisites
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 74 |
|
| 75 |
+
1. **Install Git**: [Download Git](https://git-scm.com/downloads)
|
| 76 |
+
2. **Install Node.js**: [Download Node.js](https://nodejs.org/en/download/)
|
| 77 |
|
| 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.
|
| 85 |
|
| 86 |
+
### Clone the Repository
|
| 87 |
|
| 88 |
+
Clone the repository using Git:
|
| 89 |
|
| 90 |
+
```bash
|
| 91 |
+
git clone -b stable https://github.com/stackblitz-labs/bolt.diy
|
| 92 |
+
```
|
| 93 |
|
| 94 |
+
### (Optional) Configure Environment Variables
|
| 95 |
|
| 96 |
+
Most environment variables can be configured directly through the settings menu of the application. However, if you need to manually configure them:
|
| 97 |
|
| 98 |
+
1. Rename `.env.example` to `.env.local`.
|
| 99 |
+
2. Add your LLM API keys. For example:
|
| 100 |
|
| 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 |
+
```
|
| 106 |
|
| 107 |
+
**Note**: Ollama does not require an API key as it runs locally.
|
|
|
|
|
|
|
| 108 |
|
| 109 |
+
3. Optionally, set additional configurations:
|
| 110 |
|
| 111 |
+
```env
|
| 112 |
+
# Debugging
|
| 113 |
+
VITE_LOG_LEVEL=debug
|
| 114 |
|
| 115 |
+
# Ollama settings (example: 8K context, localhost port 11434)
|
| 116 |
+
OLLAMA_API_BASE_URL=http://localhost:11434
|
| 117 |
+
DEFAULT_NUM_CTX=8192
|
| 118 |
+
```
|
| 119 |
|
| 120 |
+
**Important**: Do not commit your `.env.local` file to version control. This file is already included in `.gitignore`.
|
| 121 |
|
| 122 |
+
---
|
| 123 |
|
| 124 |
+
## Run the Application
|
| 125 |
|
| 126 |
+
### Option 1: Without Docker
|
|
|
|
|
|
|
| 127 |
|
| 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 |
+
```
|
| 136 |
|
| 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.
|
| 142 |
|
| 143 |
+
### Option 2: With Docker
|
| 144 |
|
| 145 |
+
#### Prerequisites
|
| 146 |
+
- Ensure Git, Node.js, and Docker are installed: [Download Docker](https://www.docker.com/)
|
| 147 |
|
| 148 |
+
#### Steps
|
|
|
|
|
|
|
|
|
|
|
|
|
| 149 |
|
| 150 |
+
1. **Build the Docker Image**:
|
| 151 |
|
| 152 |
+
Use the provided NPM scripts:
|
| 153 |
+
```bash
|
| 154 |
+
npm run dockerbuild # Development build
|
| 155 |
+
npm run dockerbuild:prod # Production build
|
| 156 |
+
```
|
| 157 |
|
| 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 |
+
```
|
| 163 |
|
| 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 |
+
```
|
| 170 |
|
| 171 |
+
- With the development profile, changes to your code will automatically reflect in the running container (hot reloading).
|
| 172 |
|
| 173 |
+
---
|
| 174 |
|
| 175 |
+
### Update Your Local Version to the Latest
|
| 176 |
|
| 177 |
+
To keep your local version of Bolt.diy up to date with the latest changes, follow these steps for your operating system:
|
| 178 |
|
| 179 |
+
#### 1. **Navigate to your project folder**
|
| 180 |
+
Navigate to the directory where you cloned the repository and open a terminal:
|
| 181 |
|
| 182 |
+
#### 2. **Fetch the Latest Changes**
|
| 183 |
+
Use Git to pull the latest changes from the main repository:
|
| 184 |
|
| 185 |
+
```bash
|
| 186 |
+
git pull origin main
|
| 187 |
+
```
|
| 188 |
|
| 189 |
+
#### 3. **Update Dependencies**
|
| 190 |
+
After pulling the latest changes, update the project dependencies by running the following command:
|
|
|
|
| 191 |
|
| 192 |
+
```bash
|
| 193 |
+
pnpm install
|
| 194 |
+
```
|
| 195 |
|
| 196 |
+
#### 4. **Run the Application**
|
| 197 |
+
Once the updates are complete, you can start the application again with:
|
| 198 |
|
| 199 |
+
```bash
|
| 200 |
+
pnpm run dev
|
| 201 |
+
```
|
| 202 |
|
| 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.
|
|
|
|
|
|
|
| 204 |
|
| 205 |
+
---
|
| 206 |
|
| 207 |
+
## Available Scripts
|
| 208 |
|
| 209 |
+
Here are the available commands for managing the application:
|
|
|
|
|
|
|
| 210 |
|
| 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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 220 |
|
| 221 |
## How do I contribute to Bolt.diy?
|
| 222 |
|