GamerC0der commited on
Commit
0dd9c45
Β·
verified Β·
1 Parent(s): 9dee519

Update README.md

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