Commit
·
e0d0c4b
1
Parent(s):
9efc709
Branding updates
Browse fileschanged Bolt.diy to bolt.diy
reworded the bottom of the README
- CONTRIBUTING.md +2 -2
- FAQ.md +11 -18
- README.md +31 -29
CONTRIBUTING.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
| 1 |
-
# Contributing to
|
| 2 |
|
| 3 |
-
First off, thank you for considering contributing to
|
| 4 |
|
| 5 |
## 📋 Table of Contents
|
| 6 |
- [Code of Conduct](#code-of-conduct)
|
|
|
|
| 1 |
+
# Contributing to bolt.diy
|
| 2 |
|
| 3 |
+
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.
|
| 4 |
|
| 5 |
## 📋 Table of Contents
|
| 6 |
- [Code of Conduct](#code-of-conduct)
|
FAQ.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
| 1 |
-
[](https://bolt.diy)
|
| 2 |
|
| 3 |
+
# bolt.diy
|
| 4 |
|
| 5 |
## FAQ
|
| 6 |
|
| 7 |
+
### How do I get the best results with bolt.diy?
|
| 8 |
|
| 9 |
+
- **Be specific about your stack**: If you want to use specific frameworks or libraries (like Astro, Tailwind, ShadCN, or any other popular JavaScript framework), mention them in your initial prompt to ensure bolt scaffolds the project accordingly.
|
| 10 |
|
| 11 |
- **Use the enhance prompt icon**: Before sending your prompt, try clicking the 'enhance' icon to have the AI model help you refine your prompt, then edit the results before submitting.
|
| 12 |
|
|
|
|
| 14 |
|
| 15 |
- **Batch simple instructions**: Save time by combining simple instructions into one message. For example, you can ask Bolt.diy to change the color scheme, add mobile responsiveness, and restart the dev server, all in one go saving you time and reducing API credit consumption significantly.
|
| 16 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
### Why are there so many open issues/pull requests?
|
| 18 |
|
| 19 |
+
bolt.diy was started simply to showcase how to edit an open source project and to do something cool with local LLMs on my (@ColeMedin) YouTube channel! However, it quickly grew into a massive community project that I am working hard to keep up with the demand of by forming a team of maintainers and getting as many people involved as I can. That effort is going well and all of our maintainers are ABSOLUTE rockstars, but it still takes time to organize everything so we can efficiently get through all the issues and PRs. But rest assured, we are working hard and even working on some partnerships behind the scenes to really help this project take off!
|
|
|
|
|
|
|
|
|
|
| 20 |
|
| 21 |
+
### How do local LLMs fair compared to larger models like Claude 3.5 Sonnet for bolt.diy/bolt.new?
|
| 22 |
|
| 23 |
As much as the gap is quickly closing between open source and massive close source models, you’re still going to get the best results with the very large models like GPT-4o, Claude 3.5 Sonnet, and DeepSeek Coder V2 236b. This is one of the big tasks we have at hand - figuring out how to prompt better, use agents, and improve the platform as a whole to make it work better for even the smaller local LLMs!
|
| 24 |
|
| 25 |
### I'm getting the error: "There was an error processing this request"
|
| 26 |
|
| 27 |
+
If you see this error within bolt.diy, that is just the application telling you there is a problem at a high level, and this could mean a number of different things. To find the actual error, please check BOTH the terminal where you started the application (with Docker or pnpm) and the developer console in the browser. For most browsers, you can access the developer console by pressing F12 or right clicking anywhere in the browser and selecting “Inspect”. Then go to the “console” tab in the top right.
|
| 28 |
|
| 29 |
### I'm getting the error: "x-api-key header missing"
|
| 30 |
|
| 31 |
+
We have seen this error a couple times and for some reason just restarting the Docker container has fixed it. This seems to be Ollama specific. Another thing to try is try to run bolt.diy with Docker or pnpm, whichever you didn’t run first. We are still on the hunt for why this happens once and a while!
|
| 32 |
|
| 33 |
+
### I'm getting a blank preview when bolt.diy runs my app!
|
| 34 |
|
| 35 |
+
We promise you that we are constantly testing new PRs coming into bolt.diy and the preview is core functionality, so the application is not broken! When you get a blank preview or don’t get a preview, this is generally because the LLM hallucinated bad code or incorrect commands. We are working on making this more transparent so it is obvious. Sometimes the error will appear in developer console too so check that as well.
|
| 36 |
|
| 37 |
### How to add a LLM:
|
| 38 |
|
| 39 |
+
To make new LLMs available to use in this version of bolt.new, 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.
|
| 40 |
|
| 41 |
By default, Anthropic, OpenAI, Groq, and Ollama are implemented as providers, but the YouTube video for this repo covers how to extend this to work with more providers if you wish!
|
| 42 |
|
README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
| 1 |
-
[](https://bolt.diy)
|
| 2 |
|
| 3 |
+
# bolt.diy (Previously oTToDev)
|
| 4 |
|
| 5 |
+
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.
|
| 6 |
|
| 7 |
+
Check the [bolt.diy Docs](https://stackblitz-labs.github.io/bolt.diy/) for more information. This documentation is still being updated after the transfer.
|
| 8 |
|
| 9 |
+
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!
|
| 10 |
|
| 11 |
+
## Join the community for bolt.diy!
|
| 12 |
|
| 13 |
https://thinktank.ottomator.ai
|
| 14 |
|
|
|
|
| 20 |
- ✅ Autogenerate Ollama models from what is downloaded (@yunatamos)
|
| 21 |
- ✅ Filter models by provider (@jasonm23)
|
| 22 |
- ✅ Download project as ZIP (@fabwaseem)
|
| 23 |
+
- ✅ Improvements to the main bolt.new prompt in `app\lib\.server\llm\prompts.ts` (@kofi-bhr)
|
| 24 |
- ✅ DeepSeek API Integration (@zenith110)
|
| 25 |
- ✅ Mistral API Integration (@ArulGandhi)
|
| 26 |
- ✅ "Open AI Like" API Integration (@ZerxZ)
|
|
|
|
| 45 |
- ✅ Attach images to prompts (@atrokhym)
|
| 46 |
- ✅ Detect package.json and commands to auto install and run preview for folder and git import (@wonderwhy-er)
|
| 47 |
- ✅ Selection tool to target changes visually (@emcconnell)
|
| 48 |
+
- ⬜ **HIGH PRIORITY** - Prevent bolt from rewriting files as often (file locking and diffs)
|
| 49 |
- ⬜ **HIGH PRIORITY** - Better prompting for smaller LLMs (code window sometimes doesn't start)
|
| 50 |
- ⬜ **HIGH PRIORITY** - Run agents in the backend as opposed to a single model call
|
| 51 |
- ⬜ Deploy directly to Vercel/Netlify/other similar platforms
|
|
|
|
| 57 |
- ⬜ Perplexity Integration
|
| 58 |
- ⬜ Vertex AI Integration
|
| 59 |
|
| 60 |
+
## bolt.diy Features
|
| 61 |
|
| 62 |
- **AI-powered full-stack web development** directly in your browser.
|
| 63 |
- **Support for multiple LLMs** with an extensible architecture to integrate additional models.
|
|
|
|
| 67 |
- **Download projects as ZIP** for easy portability.
|
| 68 |
- **Integration-ready Docker support** for a hassle-free setup.
|
| 69 |
|
| 70 |
+
## Setup bolt.diy
|
| 71 |
|
| 72 |
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.
|
| 73 |
|
|
|
|
| 175 |
|
| 176 |
### Update Your Local Version to the Latest
|
| 177 |
|
| 178 |
+
To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:
|
| 179 |
|
| 180 |
#### 1. **Navigate to your project folder**
|
| 181 |
Navigate to the directory where you cloned the repository and open a terminal:
|
|
|
|
| 201 |
pnpm run dev
|
| 202 |
```
|
| 203 |
|
| 204 |
+
This ensures that you're running the latest version of bolt.diy and can take advantage of all the newest features and bug fixes.
|
| 205 |
|
| 206 |
---
|
| 207 |
|
| 208 |
+
## Available Scripts
|
| 209 |
|
| 210 |
+
- **`pnpm run dev`**: Starts the development server.
|
| 211 |
+
- **`pnpm run build`**: Builds the project.
|
| 212 |
+
- **`pnpm run start`**: Runs the built application locally using Wrangler Pages.
|
| 213 |
+
- **`pnpm run preview`**: Builds and runs the production build locally.
|
| 214 |
+
- **`pnpm test`**: Runs the test suite using Vitest.
|
| 215 |
+
- **`pnpm run typecheck`**: Runs TypeScript type checking.
|
| 216 |
+
- **`pnpm run typegen`**: Generates TypeScript types using Wrangler.
|
| 217 |
+
- **`pnpm run deploy`**: Deploys the project to Cloudflare Pages.
|
| 218 |
+
- **`pnpm run lint:fix`**: Automatically fixes linting issues.
|
| 219 |
|
| 220 |
+
---
|
| 221 |
+
|
| 222 |
+
## Contributing
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 223 |
|
| 224 |
+
We welcome contributions! Check out our [Contributing Guide](CONTRIBUTING.md) to get started.
|
| 225 |
|
| 226 |
+
---
|
| 227 |
|
| 228 |
+
## Roadmap
|
| 229 |
|
| 230 |
+
Explore upcoming features and priorities on our [Roadmap](https://roadmap.sh/r/ottodev-roadmap-2ovzo).
|
| 231 |
|
| 232 |
+
---
|
| 233 |
|
| 234 |
## FAQ
|
| 235 |
|
| 236 |
+
For answers to common questions, visit our [FAQ Page](FAQ.md).
|