Skip to content

Commit ceb6819

Browse files
add an example env and rebranded the repo
1 parent cecbc55 commit ceb6819

File tree

3 files changed

+83
-31
lines changed

3 files changed

+83
-31
lines changed

README.md

Lines changed: 70 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,94 @@
1-
[![Bolt.new: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.new)
1+
[![Bolt: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.new)
22

3-
# Bolt.new: AI-Powered Full-Stack Web Development in the Browser
3+
# Bolt Community Edition
44

5-
Bolt.new is an AI-powered web development agent that allows you to prompt, run, edit, and deploy full-stack applications directly from your browser—no local setup required. If you're here to build your own AI-powered web dev agent using the Bolt open source codebase, [click here to get started!](./CONTRIBUTING.md)
5+
What makes this differnt and why did we create this fork.
66

7-
## What Makes Bolt.new Different
7+
We created this fork, since the original bolt repo was not being actively developed due to them working on their commercial edition. This edition will more closely follow there commerical repo, but allow for more frequent updates and community involvement
88

9-
Claude, v0, etc are incredible- but you can't install packages, run backends or edit code. That’s where Bolt.new stands out:
109

11-
- **Full-Stack in the Browser**: Bolt.new integrates cutting-edge AI models with an in-browser development environment powered by **StackBlitz’s WebContainers**. This allows you to:
10+
## Community
11+
Discord - https://discord.gg/t9b6Npje
12+
13+
## Getting Started
14+
To get started with Bolt Community Edition, just fork this and use npm or docker compose. More information comming soon.
15+
16+
Many of you are new users to installing software from Github. Here are a few links that will be helpfull in
17+
18+
1. Clone the repository (if you haven't already) by opening a Terminal window (or CMD with admin permissions) and then typing in this:
19+
20+
```
21+
git clone https://github.com/Bolt-CE/bolt.git
22+
```
23+
24+
2. Rename .env.example to .env.local and add your LLM API key.
25+
26+
3. Run Bolt using one of the 3 following ways:
27+
28+
If you can't see the file indicated above, its likely you can't view hidden files. On Mac, open a Terminal window and enter this command below. On Windows, you will see the hidden files option in File Explorer Settings. A quick Google search will help you if you are stuck here.
29+
30+
4a. Direct Docker Build Commands
31+
32+
You can use Docker's target feature to specify the build environment instead of using NPM scripts if you wish:
33+
34+
```bash
35+
# Development build
36+
docker build . --target bolt-ai-development
37+
38+
# Production build
39+
docker build . --target bolt-ai-production
40+
```
41+
42+
4b. Docker Compose with Profiles to Run the Container
43+
44+
Use Docker Compose profiles to manage different environments:
45+
46+
```bash
47+
# Development environment
48+
docker-compose --profile development up
49+
50+
# Production environment
51+
docker-compose --profile production up
52+
```
53+
54+
When you run the Docker Compose command with the development profile, any changes you
55+
make on your machine to the code will automatically be reflected in the site running
56+
on the container (i.e. hot reloading still applies!).
57+
58+
4c. Using npm
59+
```bash
60+
npm i . && npm run dev
61+
```
62+
63+
## AI-Powered Full-Stack Web Development in the Browser
64+
65+
Bolt is an AI-powered web development agent that allows you to prompt, run, edit, and deploy full-stack applications directly from your browser—no local setup required. If you're here to build your own AI-powered web dev agent using the Bolt open source codebase, [click here to get started!](./CONTRIBUTING.md)
66+
67+
## What Makes Bolt Different
68+
69+
Claude, v0, etc are incredible- but you can't install packages, run backends or edit code. That’s where Bolt stands out:
70+
71+
- **Full-Stack in the Browser**: Bolt integrates cutting-edge AI models with an in-browser development environment powered by **StackBlitz’s WebContainers**. This allows you to:
1272
- Install and run npm tools and libraries (like Vite, Next.js, and more)
1373
- Run Node.js servers
1474
- Interact with third-party APIs
1575
- Deploy to production from chat
1676
- Share your work via a URL
1777

18-
- **AI with Environment Control**: Unlike traditional dev environments where the AI can only assist in code generation, Bolt.new gives AI models **complete control** over the entire environment including the filesystem, node server, package manager, terminal, and browser console. This empowers AI agents to handle the entire app lifecycle—from creation to deployment.
78+
- **AI with Environment Control**: Unlike traditional dev environments where the AI can only assist in code generation, Bolt gives AI models **complete control** over the entire environment including the filesystem, node server, package manager, terminal, and browser console. This empowers AI agents to handle the entire app lifecycle—from creation to deployment.
1979

20-
Whether you’re an experienced developer, a PM or designer, Bolt.new allows you to build production-grade full-stack applications with ease.
80+
Whether you’re an experienced developer, a PM or designer, Bolt allows you to build production-grade full-stack applications with ease.
2181

2282
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
2383

2484
## Tips and Tricks
2585

26-
Here are some tips to get the most out of Bolt.new:
86+
Here are some tips to get the most out of Bolt:
2787

2888
- **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.
2989

3090
- **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.
3191

3292
- **Scaffold the basics first, then add features**: Make sure the basic structure of your application is in place before diving into more advanced functionality. This helps Bolt understand the foundation of your project and ensure everything is wired up right before building out more advanced functionality.
3393

34-
- **Batch simple instructions**: Save time by combining simple instructions into one message. For example, you can ask Bolt 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.
35-
36-
## FAQs
37-
38-
**Where do I sign up for a paid plan?**
39-
Bolt.new is free to get started. If you need more AI tokens or want private projects, you can purchase a paid subscription in your [Bolt.new](https://bolt.new) settings, in the lower-left hand corner of the application.
40-
41-
**What happens if I hit the free usage limit?**
42-
Once your free daily token limit is reached, AI interactions are paused until the next day or until you upgrade your plan.
43-
44-
**Is Bolt in beta?**
45-
Yes, Bolt.new is in beta, and we are actively improving it based on feedback.
46-
47-
**How can I report Bolt.new issues?**
48-
Check out the [Issues section](https://github.com/stackblitz/bolt.new/issues) to report an issue or request a new feature. Please use the search feature to check if someone else has already submitted the same issue/request.
49-
50-
**What frameworks/libraries currently work on Bolt?**
51-
Bolt.new supports most popular JavaScript frameworks and libraries. If it runs on StackBlitz, it will run on Bolt.new as well.
52-
53-
**How can I add make sure my framework/project works well in bolt?**
54-
We are excited to work with the JavaScript ecosystem to improve functionality in Bolt. Reach out to us via [[email protected]](mailto:[email protected]) to discuss how we can partner!
94+
- **Batch simple instructions**: Save time by combining simple instructions into one message. For example, you can ask Bolt 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.

env.example

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Rename this file to .env once you have filled in the below environment variables!
2+
# Get your Anthropic API Key in your account settings -
3+
# https://console.anthropic.com/settings/keys
4+
# You only need this environment variable set if you want to use Claude models
5+
ANTHROPIC_API_KEY=
6+
7+
# Include this environment variable if you want more logging for debugging locally
8+
VITE_LOG_LEVEL=debug

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bolt",
3-
"description": "StackBlitz AI Agent",
3+
"description": "An AI Agent",
44
"private": true,
55
"license": "MIT",
66
"packageManager": "[email protected]",
@@ -15,6 +15,10 @@
1515
"lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
1616
"lint:fix": "npm run lint -- --fix",
1717
"start": "bindings=$(./bindings.sh) && wrangler pages dev ./build/client $bindings",
18+
"dockerstart": "bindings=$(./bindings.sh) && wrangler pages dev ./build/client $bindings --ip 0.0.0.0 --port 5173 --no-show-interactive-dev-session",
19+
"dockerrun": "docker run -it -d --name bolt-ai-live -p 5173:5173 --env-file .env.local bolt-ai",
20+
"dockerbuild:prod": "docker build -t bolt-ai:production -t bolt-ai:latest --target bolt-ai-production .",
21+
"dockerbuild": "docker build -t bolt-ai:development -t bolt-ai:latest --target bolt-ai-development .",
1822
"typecheck": "tsc",
1923
"typegen": "wrangler types",
2024
"preview": "pnpm run build && pnpm run start"

0 commit comments

Comments
 (0)