Heuehneje commited on
Commit
ff6af7d
·
verified ·
1 Parent(s): b7eb7f4

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -329
README.md DELETED
@@ -1,329 +0,0 @@
1
- # bolt.diy (Previously oTToDev)
2
- [![bolt.diy: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.diy)
3
-
4
- Welcome to bolt.diy, the official open source version of Bolt.new (previously known as oTToDev and bolt.new ANY LLM), which allows you to choose the LLM that you use for each prompt! Currently, you can use OpenAI, Anthropic, Ollama, OpenRouter, Gemini, LMStudio, Mistral, xAI, HuggingFace, DeepSeek, or Groq models - and it is easily extended to use any other model supported by the Vercel AI SDK! See the instructions below for running this locally and extending it to include more models.
5
-
6
- Check the [bolt.diy Docs](https://stackblitz-labs.github.io/bolt.diy/) for more information.
7
-
8
- Also [this pinned post in our community](https://thinktank.ottomator.ai/t/videos-tutorial-helpful-content/3243) has a bunch of incredible resources for running and deploying bolt.diy yourself!
9
-
10
- We have also launched an experimental agent called the "bolt.diy Expert" that can answer common questions about bolt.diy. Find it here on the [oTTomator Live Agent Studio](https://studio.ottomator.ai/).
11
-
12
- bolt.diy was originally started by [Cole Medin](https://www.youtube.com/@ColeMedin) but has quickly grown into a massive community effort to build the BEST open source AI coding assistant!
13
-
14
- ## Table of Contents
15
-
16
- - [Join the Community](#join-the-community)
17
- - [Requested Additions](#requested-additions)
18
- - [Features](#features)
19
- - [Setup](#setup)
20
- - [Run the Application](#run-the-application)
21
- - [Available Scripts](#available-scripts)
22
- - [Contributing](#contributing)
23
- - [Roadmap](#roadmap)
24
- - [FAQ](#faq)
25
-
26
- ## Join the community
27
-
28
- [Join the bolt.diy community here, in the oTTomator Think Tank!](https://thinktank.ottomator.ai)
29
-
30
-
31
- ## Requested Additions
32
-
33
- - ✅ OpenRouter Integration (@coleam00)
34
- - ✅ Gemini Integration (@jonathands)
35
- - ✅ Autogenerate Ollama models from what is downloaded (@yunatamos)
36
- - ✅ Filter models by provider (@jasonm23)
37
- - ✅ Download project as ZIP (@fabwaseem)
38
- - ✅ Improvements to the main bolt.new prompt in `app\lib\.server\llm\prompts.ts` (@kofi-bhr)
39
- - ✅ DeepSeek API Integration (@zenith110)
40
- - ✅ Mistral API Integration (@ArulGandhi)
41
- - ✅ "Open AI Like" API Integration (@ZerxZ)
42
- - ✅ Ability to sync files (one way sync) to local folder (@muzafferkadir)
43
- - ✅ Containerize the application with Docker for easy installation (@aaronbolton)
44
- - ✅ Publish projects directly to GitHub (@goncaloalves)
45
- - ✅ Ability to enter API keys in the UI (@ali00209)
46
- - ✅ xAI Grok Beta Integration (@milutinke)
47
- - ✅ LM Studio Integration (@karrot0)
48
- - ✅ HuggingFace Integration (@ahsan3219)
49
- - ✅ Bolt terminal to see the output of LLM run commands (@thecodacus)
50
- - ✅ Streaming of code output (@thecodacus)
51
- - ✅ Ability to revert code to earlier version (@wonderwhy-er)
52
- - ✅ Cohere Integration (@hasanraiyan)
53
- - ✅ Dynamic model max token length (@hasanraiyan)
54
- - ✅ Better prompt enhancing (@SujalXplores)
55
- - ✅ Prompt caching (@SujalXplores)
56
- - ✅ Load local projects into the app (@wonderwhy-er)
57
- - ✅ Together Integration (@mouimet-infinisoft)
58
- - ✅ Mobile friendly (@qwikode)
59
- - ✅ Better prompt enhancing (@SujalXplores)
60
- - ✅ Attach images to prompts (@atrokhym)
61
- - ✅ Added Git Clone button (@thecodacus)
62
- - ✅ Git Import from url (@thecodacus)
63
- - ✅ PromptLibrary to have different variations of prompts for different use cases (@thecodacus)
64
- - ✅ Detect package.json and commands to auto install & run preview for folder and git import (@wonderwhy-er)
65
- - ✅ Selection tool to target changes visually (@emcconnell)
66
- - ✅ Detect terminal Errors and ask bolt to fix it (@thecodacus)
67
- - ✅ Detect preview Errors and ask bolt to fix it (@wonderwhy-er)
68
- - ✅ Add Starter Template Options (@thecodacus)
69
- - ✅ Perplexity Integration (@meetpateltech)
70
- - ✅ AWS Bedrock Integration (@kunjabijukchhe)
71
- - ⬜ **HIGH PRIORITY** - Prevent bolt from rewriting files as often (file locking and diffs)
72
- - ⬜ **HIGH PRIORITY** - Better prompting for smaller LLMs (code window sometimes doesn't start)
73
- - ⬜ **HIGH PRIORITY** - Run agents in the backend as opposed to a single model call
74
- - ⬜ Deploy directly to Vercel/Netlify/other similar platforms
75
- - ⬜ Have LLM plan the project in a MD file for better results/transparency
76
- - ⬜ VSCode Integration with git-like confirmations
77
- - ⬜ Upload documents for knowledge - UI design templates, a code base to reference coding style, etc.
78
- - ⬜ Voice prompting
79
- - ⬜ Azure Open AI API Integration
80
- - ⬜ Vertex AI Integration
81
-
82
- ## Features
83
-
84
- - **AI-powered full-stack web development** directly in your browser.
85
- - **Support for multiple LLMs** with an extensible architecture to integrate additional models.
86
- - **Attach images to prompts** for better contextual understanding.
87
- - **Integrated terminal** to view output of LLM-run commands.
88
- - **Revert code to earlier versions** for easier debugging and quicker changes.
89
- - **Download projects as ZIP** for easy portability.
90
- - **Integration-ready Docker support** for a hassle-free setup.
91
-
92
- ## Setup
93
-
94
- 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.
95
-
96
- Let's get you up and running with the stable version of Bolt.DIY!
97
-
98
- ## Quick Download
99
-
100
- [![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) ← Click here to go the the latest release version!
101
-
102
- - Next **click source.zip**
103
-
104
-
105
-
106
-
107
- ## Prerequisites
108
-
109
- Before you begin, you'll need to install two important pieces of software:
110
-
111
- ### Install Node.js
112
-
113
- Node.js is required to run the application.
114
-
115
- 1. Visit the [Node.js Download Page](https://nodejs.org/en/download/)
116
- 2. Download the "LTS" (Long Term Support) version for your operating system
117
- 3. Run the installer, accepting the default settings
118
- 4. Verify Node.js is properly installed:
119
- - **For Windows Users**:
120
- 1. Press `Windows + R`
121
- 2. Type "sysdm.cpl" and press Enter
122
- 3. Go to "Advanced" tab → "Environment Variables"
123
- 4. Check if `Node.js` appears in the "Path" variable
124
- - **For Mac/Linux Users**:
125
- 1. Open Terminal
126
- 2. Type this command:
127
- ```bash
128
- echo $PATH
129
- ```
130
- 3. Look for `/usr/local/bin` in the output
131
-
132
- ## Running the Application
133
-
134
- You have two options for running Bolt.DIY: directly on your machine or using Docker.
135
-
136
- ### Option 1: Direct Installation (Recommended for Beginners)
137
-
138
- 1. **Install Package Manager (pnpm)**:
139
- ```bash
140
- npm install -g pnpm
141
- ```
142
-
143
- 2. **Install Project Dependencies**:
144
- ```bash
145
- pnpm install
146
- ```
147
-
148
- 3. **Start the Application**:
149
- ```bash
150
- pnpm run dev
151
- ```
152
-
153
- **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/)
154
-
155
- ### Option 2: Using Docker
156
-
157
- This option requires some familiarity with Docker but provides a more isolated environment.
158
-
159
- #### Additional Prerequisite
160
- - Install Docker: [Download Docker](https://www.docker.com/)
161
-
162
- #### Steps:
163
-
164
- 1. **Build the Docker Image**:
165
- ```bash
166
- # Using npm script:
167
- npm run dockerbuild
168
-
169
- # OR using direct Docker command:
170
- docker build . --target bolt-ai-development
171
- ```
172
-
173
- 2. **Run the Container**:
174
- ```bash
175
- docker-compose --profile development up
176
- ```
177
-
178
-
179
-
180
-
181
- ## Configuring API Keys and Providers
182
-
183
- ### Adding Your API Keys
184
-
185
- Setting up your API keys in Bolt.DIY is straightforward:
186
-
187
- 1. Open the home page (main interface)
188
- 2. Select your desired provider from the dropdown menu
189
- 3. Click the pencil (edit) icon
190
- 4. Enter your API key in the secure input field
191
-
192
- ![API Key Configuration Interface](./docs/images/api-key-ui-section.png)
193
-
194
- ### Configuring Custom Base URLs
195
-
196
- For providers that support custom base URLs (such as Ollama or LM Studio), follow these steps:
197
-
198
- 1. Click the settings icon in the sidebar to open the settings menu
199
- ![Settings Button Location](./docs/images/bolt-settings-button.png)
200
-
201
- 2. Navigate to the "Providers" tab
202
- 3. Search for your provider using the search bar
203
- 4. Enter your custom base URL in the designated field
204
- ![Provider Base URL Configuration](./docs/images/provider-base-url.png)
205
-
206
- > **Note**: Custom base URLs are particularly useful when running local instances of AI models or using custom API endpoints.
207
-
208
- ### Supported Providers
209
- - Ollama
210
- - LM Studio
211
- - OpenAILike
212
-
213
- ## Setup Using Git (For Developers only)
214
-
215
- This method is recommended for developers who want to:
216
- - Contribute to the project
217
- - Stay updated with the latest changes
218
- - Switch between different versions
219
- - Create custom modifications
220
-
221
- #### Prerequisites
222
- 1. Install Git: [Download Git](https://git-scm.com/downloads)
223
-
224
- #### Initial Setup
225
-
226
- 1. **Clone the Repository**:
227
- ```bash
228
- # Using HTTPS
229
- git clone https://github.com/stackblitz-labs/bolt.diy.git
230
- ```
231
-
232
- 2. **Navigate to Project Directory**:
233
- ```bash
234
- cd bolt.diy
235
- ```
236
-
237
- 3. **Switch to the Main Branch**:
238
- ```bash
239
- git checkout main
240
- ```
241
- 4. **Install Dependencies**:
242
- ```bash
243
- pnpm install
244
- ```
245
-
246
- 5. **Start the Development Server**:
247
- ```bash
248
- pnpm run dev
249
- ```
250
-
251
- #### Staying Updated
252
-
253
- To get the latest changes from the repository:
254
-
255
- 1. **Save Your Local Changes** (if any):
256
- ```bash
257
- git stash
258
- ```
259
-
260
- 2. **Pull Latest Updates**:
261
- ```bash
262
- git pull origin main
263
- ```
264
-
265
- 3. **Update Dependencies**:
266
- ```bash
267
- pnpm install
268
- ```
269
-
270
- 4. **Restore Your Local Changes** (if any):
271
- ```bash
272
- git stash pop
273
- ```
274
-
275
- #### Troubleshooting Git Setup
276
-
277
- If you encounter issues:
278
-
279
- 1. **Clean Installation**:
280
- ```bash
281
- # Remove node modules and lock files
282
- rm -rf node_modules pnpm-lock.yaml
283
-
284
- # Clear pnpm cache
285
- pnpm store prune
286
-
287
- # Reinstall dependencies
288
- pnpm install
289
- ```
290
-
291
- 2. **Reset Local Changes**:
292
- ```bash
293
- # Discard all local changes
294
- git reset --hard origin/main
295
- ```
296
-
297
- Remember to always commit your local changes or stash them before pulling updates to avoid conflicts.
298
-
299
- ---
300
-
301
- ## Available Scripts
302
-
303
- - **`pnpm run dev`**: Starts the development server.
304
- - **`pnpm run build`**: Builds the project.
305
- - **`pnpm run start`**: Runs the built application locally using Wrangler Pages.
306
- - **`pnpm run preview`**: Builds and runs the production build locally.
307
- - **`pnpm test`**: Runs the test suite using Vitest.
308
- - **`pnpm run typecheck`**: Runs TypeScript type checking.
309
- - **`pnpm run typegen`**: Generates TypeScript types using Wrangler.
310
- - **`pnpm run deploy`**: Deploys the project to Cloudflare Pages.
311
- - **`pnpm run lint:fix`**: Automatically fixes linting issues.
312
-
313
- ---
314
-
315
- ## Contributing
316
-
317
- We welcome contributions! Check out our [Contributing Guide](CONTRIBUTING.md) to get started.
318
-
319
- ---
320
-
321
- ## Roadmap
322
-
323
- Explore upcoming features and priorities on our [Roadmap](https://roadmap.sh/r/ottodev-roadmap-2ovzo).
324
-
325
- ---
326
-
327
- ## FAQ
328
-
329
- For answers to common questions, issues, and to see a list of recommended models, visit our [FAQ Page](FAQ.md).