From fc779b5b1f49181d9a5f63130dd7815002692cef Mon Sep 17 00:00:00 2001 From: Leex Date: Sat, 8 Mar 2025 23:08:40 +0100 Subject: [PATCH 1/5] update: docs README.md - changed git clone for pulling stable branch, not main anymore - Removed some not needed stuff --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3071fcee..f92a21ff 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# bolt.diy (Previously oTToDev) +# bolt.diy [![bolt.diy: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.diy) -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. +Welcome to bolt.diy, the official open source version of Bolt.new, 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. ----- Check the [bolt.diy Docs](https://stackblitz-labs.github.io/bolt.diy/) for more offical installation instructions and more informations. @@ -83,7 +83,8 @@ project, please check the [project management guide](./PROJECT.md) to get starte - ⬜ **HIGH PRIORITY** - Prevent bolt from rewriting files as often (file locking and diffs) - ⬜ **HIGH PRIORITY** - Better prompting for smaller LLMs (code window sometimes doesn't start) - ⬜ **HIGH PRIORITY** - Run agents in the backend as opposed to a single model call -- ⬜ Deploy directly to Vercel/Netlify/other similar platforms +- ✅ Deploy directly to Netlify (@xKevIsDev) +- ⬜ Supabase Integration - ⬜ Have LLM plan the project in a MD file for better results/transparency - ⬜ VSCode Integration with git-like confirmations - ⬜ Upload documents for knowledge - UI design templates, a code base to reference coding style, etc. @@ -101,8 +102,9 @@ project, please check the [project management guide](./PROJECT.md) to get starte - **Attach images to prompts** for better contextual understanding. - **Integrated terminal** to view output of LLM-run commands. - **Revert code to earlier versions** for easier debugging and quicker changes. -- **Download projects as ZIP** for easy portability. +- **Download projects as ZIP** for easy portabilitr Sync to a folder on the host. - **Integration-ready Docker support** for a hassle-free setup. +- **Deploy** directly to **Netlify** ## Setup @@ -241,8 +243,7 @@ This method is recommended for developers who want to: 1. **Clone the Repository**: ```bash - # Using HTTPS - git clone https://github.com/stackblitz-labs/bolt.diy.git + git clone -b stable https://github.com/stackblitz-labs/bolt.diy.git ``` 2. **Navigate to Project Directory**: @@ -251,21 +252,25 @@ This method is recommended for developers who want to: cd bolt.diy ``` -3. **Switch to the Main Branch**: - ```bash - git checkout main - ``` -4. **Install Dependencies**: +3. **Install Dependencies**: ```bash pnpm install ``` -5. **Start the Development Server**: +4. **Start the Development Server**: ```bash pnpm run dev ``` +5. **(OPTIONAL)** Switch to the Main Branch if you want to use pre-release/testbranch): + ```bash + git checkout main + ``` + Hint: Be aware that this can have beta-features and more likely got bugs than the stable release + + + #### Staying Updated To get the latest changes from the repository: @@ -279,7 +284,7 @@ To get the latest changes from the repository: 2. **Pull Latest Updates**: ```bash - git pull origin main + git pull ``` 3. **Update Dependencies**: From a696d5f254acc7e9ac0ad4c5e17021c2780e1074 Mon Sep 17 00:00:00 2001 From: Leex Date: Sun, 9 Mar 2025 23:44:23 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f92a21ff..f38e23c0 100644 --- a/README.md +++ b/README.md @@ -263,13 +263,19 @@ This method is recommended for developers who want to: pnpm run dev ``` -5. **(OPTIONAL)** Switch to the Main Branch if you want to use pre-release/testbranch): +5. **(OPTIONAL)** Switch to the Main Branch if you want to use pre-release/testbranch: ```bash git checkout main + pnpm install + pnpm run dev ``` Hint: Be aware that this can have beta-features and more likely got bugs than the stable release - +>**Open the WebUI to test (Default: http://localhost:5173)** +> - Beginngers: +> - Try to use a sophisticated Provider/Model like Anthropic with Claude Sonnet 3.x Models to get best results +> - Explanation: The System Prompt currently implemented in bolt.diy cant cover the best performance for all providers and models out there. So it works better with some models, then other, even if the models itself are perfect for >programming +> - Future: Planned is a Plugin/Extentions-Library so there can be different System Prompts for different Models, which will help to get better results #### Staying Updated From 27fbfb76c4b95d55d837e78d399ea20de11e86dc Mon Sep 17 00:00:00 2001 From: Leex Date: Mon, 10 Mar 2025 00:05:36 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f38e23c0..c14974b2 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ project, please check the [project management guide](./PROJECT.md) to get starte - **Attach images to prompts** for better contextual understanding. - **Integrated terminal** to view output of LLM-run commands. - **Revert code to earlier versions** for easier debugging and quicker changes. -- **Download projects as ZIP** for easy portabilitr Sync to a folder on the host. +- **Download projects as ZIP** for easy portability Sync to a folder on the host. - **Integration-ready Docker support** for a hassle-free setup. - **Deploy** directly to **Netlify** From 7107163f3103eddcc209f6ac552f9fd85d54409c Mon Sep 17 00:00:00 2001 From: Leex Date: Tue, 18 Mar 2025 10:54:39 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index c14974b2..15a45169 100644 --- a/README.md +++ b/README.md @@ -360,3 +360,9 @@ Explore upcoming features and priorities on our [Roadmap](https://roadmap.sh/r/o ## FAQ For answers to common questions, issues, and to see a list of recommended models, visit our [FAQ Page](FAQ.md). + + +# Licensing +**Who needs a commercial WebContainer API license?** + +Licensing is required for production usage of the API in a commercial, for-profit setting. (Prototypes or POCs do not require a commercial license.) If you're using the API to meet the needs of your customers, prospective customers, and/or employees, you need a license to ensure compliance with our Terms of Service. Usage of the API in violation of these terms may result in your access being revoked. From 64afda10781d96749cbae44b9b7e3e62d8e02b53 Mon Sep 17 00:00:00 2001 From: Leex Date: Tue, 18 Mar 2025 11:40:49 +0100 Subject: [PATCH 5/5] Update README.md Co-authored-by: patak <583075+patak-dev@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 15a45169..74f807b5 100644 --- a/README.md +++ b/README.md @@ -365,4 +365,4 @@ For answers to common questions, issues, and to see a list of recommended models # Licensing **Who needs a commercial WebContainer API license?** -Licensing is required for production usage of the API in a commercial, for-profit setting. (Prototypes or POCs do not require a commercial license.) If you're using the API to meet the needs of your customers, prospective customers, and/or employees, you need a license to ensure compliance with our Terms of Service. Usage of the API in violation of these terms may result in your access being revoked. +bolt.diy source code is distributed as MIT, but it uses WebContainers API that [requires licensing](https://webcontainers.io/enterprise) for production usage in a commercial, for-profit setting. (Prototypes or POCs do not require a commercial license.) If you're using the API to meet the needs of your customers, prospective customers, and/or employees, you need a license to ensure compliance with our Terms of Service. Usage of the API in violation of these terms may result in your access being revoked.