LlamaFinetuneGGUF commited on
Commit
ab5cde3
·
unverified ·
2 Parent(s): 2638c1a f2662c1

docs: setup updated

Browse files

docs: updated setup guide to have more detailed instructions

README.md CHANGED
@@ -87,112 +87,206 @@ bolt.diy was originally started by [Cole Medin](https://www.youtube.com/@ColeMed
87
 
88
  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.
89
 
90
- ### Prerequisites
91
 
92
- 1. **Install Git**: [Download Git](https://git-scm.com/downloads)
93
- 2. **Install Node.js**: [Download Node.js](https://nodejs.org/en/download/)
94
 
95
- - After installation, the Node.js path is usually added to your system automatically. To verify:
96
- - **Windows**: Search for "Edit the system environment variables," click "Environment Variables," and check if `Node.js` is in the `Path` variable.
97
- - **Mac/Linux**: Open a terminal and run:
98
- ```bash
99
- echo $PATH
100
- ```
101
- Look for `/usr/local/bin` in the output.
102
 
103
- ### Clone the Repository
104
 
105
- Clone the repository using Git:
106
 
107
- ```bash
108
- git clone -b stable https://github.com/stackblitz-labs/bolt.diy
109
- ```
110
 
111
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
112
 
113
- ## Run the Application
114
 
115
- ### Option 1: Without Docker
 
 
 
116
 
117
- 1. **Install Dependencies**:
118
- ```bash
119
- pnpm install
120
- ```
121
- If `pnpm` is not installed, install it using:
122
- ```bash
123
- sudo npm install -g pnpm
124
- ```
125
 
126
- 2. **Start the Application**:
127
- ```bash
128
- pnpm run dev
129
  ```
130
- 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.
131
 
132
- ### Option 2: With Docker
 
 
133
 
134
- #### Prerequisites
135
- - Ensure Git, Node.js, and Docker are installed: [Download Docker](https://www.docker.com/)
136
 
137
- #### Steps
 
138
 
139
- 1. **Build the Docker Image**:
140
 
141
- Use the provided NPM scripts:
142
- ```bash
143
- npm run dockerbuild
144
- ```
145
 
146
- Alternatively, use Docker commands directly:
147
- ```bash
148
  docker build . --target bolt-ai-development
149
- ```
 
 
 
 
 
150
 
151
- 2. **Run the Container**:
152
- Use Docker Compose profiles to manage environments:
153
- ```bash
154
- docker-compose --profile development up
155
- ```
156
 
157
- - With the development profile, changes to your code will automatically reflect in the running container (hot reloading).
158
 
159
- ---
160
 
161
- ### Entering API Keys
162
 
163
- All of your API Keys can be configured directly in the application. Just selecte the provider you want from the dropdown and click the pencile icon to enter your API key.
164
 
165
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
166
 
167
- ### Update Your Local Version to the Latest
 
 
 
168
 
169
- To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:
170
 
171
- #### 1. **Navigate to your project folder**
172
- Navigate to the directory where you cloned the repository and open a terminal:
 
 
173
 
174
- #### 2. **Fetch the Latest Changes**
175
- Use Git to pull the latest changes from the main repository:
176
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
177
  ```bash
178
- git pull origin main
 
179
  ```
180
 
181
- #### 3. **Update Dependencies**
182
- After pulling the latest changes, update the project dependencies by running the following command:
 
 
183
 
 
184
  ```bash
185
- pnpm install
186
  ```
187
 
188
- #### 4. **Run the Application**
189
- Once the updates are complete, you can start the application again with:
 
 
190
 
 
191
  ```bash
192
  pnpm run dev
193
  ```
194
 
195
- This ensures that you're running the latest version of bolt.diy and can take advantage of all the newest features and bug fixes.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
196
 
197
  ---
198
 
 
87
 
88
  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.
89
 
90
+ Let's get you up and running with the stable version of Bolt.DIY!
91
 
92
+ ## Quick Download
 
93
 
94
+ [![Download Latest Release](https://img.shields.io/github/v/release/stackblitz-labs/bolt.diy?label=Download%20Bolt&sort=semver)](https://github.com/stackblitz-labs/bolt.diy/releases/latest/download/bolt.diy.zip) Click here to download the latest version!
 
 
 
 
 
 
95
 
96
+ ## Prerequisites
97
 
98
+ Before you begin, you'll need to install two important pieces of software:
99
 
100
+ ### Install Node.js
 
 
101
 
102
+ Node.js is required to run the application.
103
+
104
+ 1. Visit the [Node.js Download Page](https://nodejs.org/en/download/)
105
+ 2. Download the "LTS" (Long Term Support) version for your operating system
106
+ 3. Run the installer, accepting the default settings
107
+ 4. Verify Node.js is properly installed:
108
+ - **For Windows Users**:
109
+ 1. Press `Windows + R`
110
+ 2. Type "sysdm.cpl" and press Enter
111
+ 3. Go to "Advanced" tab → "Environment Variables"
112
+ 4. Check if `Node.js` appears in the "Path" variable
113
+ - **For Mac/Linux Users**:
114
+ 1. Open Terminal
115
+ 2. Type this command:
116
+ ```bash
117
+ echo $PATH
118
+ ```
119
+ 3. Look for `/usr/local/bin` in the output
120
+
121
+ ## Running the Application
122
+
123
+ You have two options for running Bolt.DIY: directly on your machine or using Docker.
124
 
125
+ ### Option 1: Direct Installation (Recommended for Beginners)
126
 
127
+ 1. **Install Package Manager (pnpm)**:
128
+ ```bash
129
+ npm install -g pnpm
130
+ ```
131
 
132
+ 2. **Install Project Dependencies**:
133
+ ```bash
134
+ pnpm install
135
+ ```
 
 
 
 
136
 
137
+ 3. **Start the Application**:
138
+ ```bash
139
+ pnpm run dev
140
  ```
 
141
 
142
+ **Important Note**: If you're using Google Chrome, you'll need Chrome Canary for local development. [Download it here](https://www.google.com/chrome/canary/)
143
+
144
+ ### Option 2: Using Docker
145
 
146
+ This option requires some familiarity with Docker but provides a more isolated environment.
 
147
 
148
+ #### Additional Prerequisite
149
+ - Install Docker: [Download Docker](https://www.docker.com/)
150
 
151
+ #### Steps:
152
 
153
+ 1. **Build the Docker Image**:
154
+ ```bash
155
+ # Using npm script:
156
+ npm run dockerbuild
157
 
158
+ # OR using direct Docker command:
 
159
  docker build . --target bolt-ai-development
160
+ ```
161
+
162
+ 2. **Run the Container**:
163
+ ```bash
164
+ docker-compose --profile development up
165
+ ```
166
 
 
 
 
 
 
167
 
 
168
 
 
169
 
170
+ ## Configuring API Keys and Providers
171
 
172
+ ### Adding Your API Keys
173
 
174
+ Setting up your API keys in Bolt.DIY is straightforward:
175
+
176
+ 1. Open the home page (main interface)
177
+ 2. Select your desired provider from the dropdown menu
178
+ 3. Click the pencil (edit) icon
179
+ 4. Enter your API key in the secure input field
180
+
181
+ ![API Key Configuration Interface](./docs/images/api-key-ui-section.png)
182
+
183
+ ### Configuring Custom Base URLs
184
+
185
+ For providers that support custom base URLs (such as Ollama or LM Studio), follow these steps:
186
+
187
+ 1. Click the settings icon in the sidebar to open the settings menu
188
+ ![Settings Button Location](./docs/images/bolt-settings-button.png)
189
 
190
+ 2. Navigate to the "Providers" tab
191
+ 3. Search for your provider using the search bar
192
+ 4. Enter your custom base URL in the designated field
193
+ ![Provider Base URL Configuration](./docs/images/provider-base-url.png)
194
 
195
+ > **Note**: Custom base URLs are particularly useful when running local instances of AI models or using custom API endpoints.
196
 
197
+ ### Supported Providers
198
+ - Ollama
199
+ - LM Studio
200
+ - OpenAILike
201
 
 
 
202
 
203
+
204
+ ## Setup Using Git (For Developers only)
205
+
206
+ This method is recommended for developers who want to:
207
+ - Contribute to the project
208
+ - Stay updated with the latest changes
209
+ - Switch between different versions
210
+ - Create custom modifications
211
+
212
+ #### Prerequisites
213
+ 1. Install Git: [Download Git](https://git-scm.com/downloads)
214
+
215
+ #### Initial Setup
216
+
217
+ 1. **Clone the Repository**:
218
  ```bash
219
+ # Using HTTPS
220
+ git clone https://github.com/stackblitz-labs/bolt.diy.git
221
  ```
222
 
223
+ 2. **Navigate to Project Directory**:
224
+ ```bash
225
+ cd bolt.diy
226
+ ```
227
 
228
+ 3. **Switch to the Main Branch**:
229
  ```bash
230
+ git checkout main
231
  ```
232
 
233
+ 4. **Install Dependencies**:
234
+ ```bash
235
+ pnpm install
236
+ ```
237
 
238
+ 5. **Start the Development Server**:
239
  ```bash
240
  pnpm run dev
241
  ```
242
 
243
+ #### Staying Updated
244
+
245
+ To get the latest changes from the repository:
246
+
247
+ 1. **Save Your Local Changes** (if any):
248
+ ```bash
249
+ git stash
250
+ ```
251
+
252
+ 2. **Pull Latest Updates**:
253
+ ```bash
254
+ git pull origin main
255
+ ```
256
+
257
+ 3. **Update Dependencies**:
258
+ ```bash
259
+ pnpm install
260
+ ```
261
+
262
+ 4. **Restore Your Local Changes** (if any):
263
+ ```bash
264
+ git stash pop
265
+ ```
266
+
267
+ #### Troubleshooting Git Setup
268
+
269
+ If you encounter issues:
270
+
271
+ 1. **Clean Installation**:
272
+ ```bash
273
+ # Remove node modules and lock files
274
+ rm -rf node_modules pnpm-lock.yaml
275
+
276
+ # Clear pnpm cache
277
+ pnpm store prune
278
+
279
+ # Reinstall dependencies
280
+ pnpm install
281
+ ```
282
+
283
+ 2. **Reset Local Changes**:
284
+ ```bash
285
+ # Discard all local changes
286
+ git reset --hard origin/main
287
+ ```
288
+
289
+ Remember to always commit your local changes or stash them before pulling updates to avoid conflicts.
290
 
291
  ---
292
 
app/commit.json CHANGED
@@ -1 +1 @@
1
- { "commit": "636f87f568a368dadc5cf3c077284710951e2488", "version": "0.0.3" }
 
1
+ { "commit": "1398344c11f227c167ad1d726a734ea534d3e03a" }
docs/images/api-key-ui-section.png ADDED
docs/images/bolt-settings-button.png ADDED
docs/images/provider-base-url.png ADDED