Skip to content

Commit a930916

Browse files
authored
Merge pull request #817 from dustinwloring1988/docs/more-beginner-friendly
docs: simplified setup
2 parents 6003c16 + 278bd24 commit a930916

File tree

1 file changed

+9
-34
lines changed

1 file changed

+9
-34
lines changed

README.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -95,34 +95,6 @@ Clone the repository using Git:
9595
git clone -b stable https://github.com/stackblitz-labs/bolt.diy
9696
```
9797

98-
### (Optional) Configure Environment Variables
99-
100-
Most environment variables can be configured directly through the settings menu of the application. However, if you need to manually configure them:
101-
102-
1. Rename `.env.example` to `.env.local`.
103-
2. Add your LLM API keys. For example:
104-
105-
```env
106-
GROQ_API_KEY=YOUR_GROQ_API_KEY
107-
OPENAI_API_KEY=YOUR_OPENAI_API_KEY
108-
ANTHROPIC_API_KEY=YOUR_ANTHROPIC_API_KEY
109-
```
110-
111-
**Note**: Ollama does not require an API key as it runs locally.
112-
113-
3. Optionally, set additional configurations:
114-
115-
```env
116-
# Debugging
117-
VITE_LOG_LEVEL=debug
118-
119-
# Ollama settings (example: 8K context, localhost port 11434)
120-
OLLAMA_API_BASE_URL=http://localhost:11434
121-
DEFAULT_NUM_CTX=8192
122-
```
123-
124-
**Important**: Do not commit your `.env.local` file to version control. This file is already included in `.gitignore`.
125-
12698
---
12799

128100
## Run the Application
@@ -155,27 +127,30 @@ DEFAULT_NUM_CTX=8192
155127
156128
Use the provided NPM scripts:
157129
```bash
158-
npm run dockerbuild # Development build
159-
npm run dockerbuild:prod # Production build
130+
npm run dockerbuild
160131
```
161132
162133
Alternatively, use Docker commands directly:
163134
```bash
164-
docker build . --target bolt-ai-development # Development build
165-
docker build . --target bolt-ai-production # Production build
135+
docker build . --target bolt-ai-development
166136
```
167137
168138
2. **Run the Container**:
169139
Use Docker Compose profiles to manage environments:
170140
```bash
171-
docker-compose --profile development up # Development
172-
docker-compose --profile production up # Production
141+
docker-compose --profile development up
173142
```
174143
175144
- With the development profile, changes to your code will automatically reflect in the running container (hot reloading).
176145
177146
---
178147
148+
### Entering API Keys
149+
150+
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.
151+
152+
---
153+
179154
### Update Your Local Version to the Latest
180155
181156
To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:

0 commit comments

Comments
 (0)