You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/CONTRIBUTING.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,14 @@
8
8
-[Development Setup](#development-setup)
9
9
-[Deploymnt with Docker](#docker-deployment-documentation)
10
10
11
+
---
12
+
11
13
## Code of Conduct
12
14
13
15
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
14
16
17
+
---
18
+
15
19
## How Can I Contribute?
16
20
17
21
### 🐞 Reporting Bugs and Feature Requests
@@ -29,6 +33,8 @@ This project and everyone participating in it is governed by our Code of Conduct
29
33
### ✨ Becoming a Core Contributor
30
34
We're looking for dedicated contributors to help maintain and grow this project. If you're interested in becoming a core contributor, please fill out our [Contributor Application Form](https://forms.gle/TBSteXSDCtBDwr5m7).
31
35
36
+
---
37
+
32
38
## Pull Request Guidelines
33
39
34
40
### 📝 PR Checklist
@@ -43,6 +49,8 @@ We're looking for dedicated contributors to help maintain and grow this project.
43
49
3. Address all review comments
44
50
4. Maintain clean commit history
45
51
52
+
---
53
+
46
54
## Coding Standards
47
55
48
56
### 💻 General Guidelines
@@ -51,6 +59,8 @@ We're looking for dedicated contributors to help maintain and grow this project.
51
59
- Keep functions focused and small
52
60
- Use meaningful variable names
53
61
62
+
---
63
+
54
64
## Development Setup
55
65
56
66
### 🔄 Initial Setup
@@ -100,6 +110,8 @@ pnpm run dev
100
110
101
111
**Note**: 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.
102
112
113
+
---
114
+
103
115
## Testing
104
116
105
117
Run the test suite with:
@@ -108,6 +120,8 @@ Run the test suite with:
108
120
pnpm test
109
121
```
110
122
123
+
---
124
+
111
125
## Deployment
112
126
113
127
To deploy the application to Cloudflare Pages:
@@ -118,6 +132,8 @@ pnpm run deploy
118
132
119
133
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
120
134
135
+
---
136
+
121
137
# Docker Deployment Documentation
122
138
123
139
This guide outlines various methods for building and deploying the application using Docker.
The `docker-compose.yaml` configuration is compatible with VS Code dev containers:
@@ -197,19 +217,25 @@ The `docker-compose.yaml` configuration is compatible with VS Code dev container
197
217
2. Select the dev container configuration
198
218
3. Choose the "development" profile from the context menu
199
219
220
+
---
221
+
200
222
## Environment Files
201
223
202
224
Ensure you have the appropriate `.env.local` file configured before running the containers. This file should contain:
203
225
- API keys
204
226
- Environment-specific configurations
205
227
- Other required environment variables
206
228
229
+
---
230
+
207
231
## DEFAULT_NUM_CTX
208
232
209
233
The `DEFAULT_NUM_CTX` environment variable can be used to limit the maximum number of context values used by the qwen2.5-coder model. For example, to limit the context to 24576 values (which uses 32GB of VRAM), set `DEFAULT_NUM_CTX=24576` in your `.env.local` file.
210
234
211
235
First off, thank you for considering contributing to bolt.diy! This fork aims to expand the capabilities of the original project by integrating multiple LLM providers and enhancing functionality. Every contribution helps make bolt.diy a better tool for developers worldwide.
212
236
237
+
---
238
+
213
239
## Notes
214
240
215
241
- Port 5173 is exposed and mapped for both development and production environments
Copy file name to clipboardExpand all lines: docs/docs/index.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@ https://thinktank.ottomator.ai
9
9
10
10
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)
11
11
12
+
---
13
+
12
14
## What Makes bolt.diy Different
13
15
14
16
Claude, v0, etc are incredible- but you can't install packages, run backends, or edit code. That’s where bolt.diy stands out:
@@ -26,6 +28,8 @@ Whether you’re an experienced developer, a PM, or a designer, bolt.diy allows
26
28
27
29
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
28
30
31
+
---
32
+
29
33
## Setup
30
34
31
35
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.
@@ -128,6 +132,8 @@ When you run the Docker Compose command with the development profile, any change
128
132
make on your machine to the code will automatically be reflected in the site running
129
133
on the container (i.e. hot reloading still applies!).
130
134
135
+
---
136
+
131
137
## Run Without Docker
132
138
133
139
1. Install dependencies using Terminal (or CMD in Windows with admin permissions):
@@ -148,6 +154,8 @@ sudo npm install -g pnpm
148
154
pnpm run dev
149
155
```
150
156
157
+
---
158
+
151
159
## Adding New LLMs:
152
160
153
161
To make new LLMs available to use in this version of bolt.diy, head on over to `app/utils/constants.ts` and find the constant MODEL_LIST. Each element in this array is an object that has the model ID for the name (get this from the provider's API documentation), a label for the frontend model dropdown, and the provider.
@@ -156,6 +164,8 @@ By default, Anthropic, OpenAI, Groq, and Ollama are implemented as providers, bu
156
164
157
165
When you add a new model to the MODEL_LIST array, it will immediately be available to use when you run the app locally or reload it. For Ollama models, make sure you have the model installed already before trying to use it here!
158
166
167
+
---
168
+
159
169
## Available Scripts
160
170
161
171
-`pnpm run dev`: Starts the development server.
@@ -167,6 +177,8 @@ When you add a new model to the MODEL_LIST array, it will immediately be availab
167
177
-`pnpm run typegen`: Generates TypeScript types using Wrangler.
168
178
-`pnpm run deploy`: Builds the project and deploys it to Cloudflare Pages.
169
179
180
+
---
181
+
170
182
## Development
171
183
172
184
To start the development server:
@@ -177,6 +189,8 @@ pnpm run dev
177
189
178
190
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.
179
191
192
+
---
193
+
180
194
## Tips and Tricks
181
195
182
196
Here are some tips to get the most out of bolt.diy:
0 commit comments