-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add an example env and rebranded the repo
- Loading branch information
1 parent
cecbc55
commit ceb6819
Showing
3 changed files
with
83 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,94 @@ | ||
[](https://bolt.new) | ||
[](https://bolt.new) | ||
|
||
# Bolt.new: AI-Powered Full-Stack Web Development in the Browser | ||
# Bolt Community Edition | ||
|
||
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) | ||
What makes this differnt and why did we create this fork. | ||
|
||
## What Makes Bolt.new Different | ||
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 | ||
|
||
Claude, v0, etc are incredible- but you can't install packages, run backends or edit code. That’s where Bolt.new stands out: | ||
|
||
- **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: | ||
## Community | ||
Discord - https://discord.gg/t9b6Npje | ||
|
||
## Getting Started | ||
To get started with Bolt Community Edition, just fork this and use npm or docker compose. More information comming soon. | ||
|
||
Many of you are new users to installing software from Github. Here are a few links that will be helpfull in | ||
|
||
1. Clone the repository (if you haven't already) by opening a Terminal window (or CMD with admin permissions) and then typing in this: | ||
|
||
``` | ||
git clone https://github.com/Bolt-CE/bolt.git | ||
``` | ||
|
||
2. Rename .env.example to .env.local and add your LLM API key. | ||
|
||
3. Run Bolt using one of the 3 following ways: | ||
|
||
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. | ||
|
||
4a. Direct Docker Build Commands | ||
|
||
You can use Docker's target feature to specify the build environment instead of using NPM scripts if you wish: | ||
|
||
```bash | ||
# Development build | ||
docker build . --target bolt-ai-development | ||
|
||
# Production build | ||
docker build . --target bolt-ai-production | ||
``` | ||
|
||
4b. Docker Compose with Profiles to Run the Container | ||
|
||
Use Docker Compose profiles to manage different environments: | ||
|
||
```bash | ||
# Development environment | ||
docker-compose --profile development up | ||
|
||
# Production environment | ||
docker-compose --profile production up | ||
``` | ||
|
||
When you run the Docker Compose command with the development profile, any changes you | ||
make on your machine to the code will automatically be reflected in the site running | ||
on the container (i.e. hot reloading still applies!). | ||
|
||
4c. Using npm | ||
```bash | ||
npm i . && npm run dev | ||
``` | ||
|
||
## AI-Powered Full-Stack Web Development in the Browser | ||
|
||
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) | ||
|
||
## What Makes Bolt Different | ||
|
||
Claude, v0, etc are incredible- but you can't install packages, run backends or edit code. That’s where Bolt stands out: | ||
|
||
- **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: | ||
- Install and run npm tools and libraries (like Vite, Next.js, and more) | ||
- Run Node.js servers | ||
- Interact with third-party APIs | ||
- Deploy to production from chat | ||
- Share your work via a URL | ||
|
||
- **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. | ||
- **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. | ||
|
||
Whether you’re an experienced developer, a PM or designer, Bolt.new allows you to build production-grade full-stack applications with ease. | ||
Whether you’re an experienced developer, a PM or designer, Bolt allows you to build production-grade full-stack applications with ease. | ||
|
||
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo! | ||
|
||
## Tips and Tricks | ||
|
||
Here are some tips to get the most out of Bolt.new: | ||
Here are some tips to get the most out of Bolt: | ||
|
||
- **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. | ||
|
||
- **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. | ||
|
||
- **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. | ||
|
||
- **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. | ||
|
||
## FAQs | ||
|
||
**Where do I sign up for a paid plan?** | ||
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. | ||
|
||
**What happens if I hit the free usage limit?** | ||
Once your free daily token limit is reached, AI interactions are paused until the next day or until you upgrade your plan. | ||
|
||
**Is Bolt in beta?** | ||
Yes, Bolt.new is in beta, and we are actively improving it based on feedback. | ||
|
||
**How can I report Bolt.new issues?** | ||
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. | ||
|
||
**What frameworks/libraries currently work on Bolt?** | ||
Bolt.new supports most popular JavaScript frameworks and libraries. If it runs on StackBlitz, it will run on Bolt.new as well. | ||
|
||
**How can I add make sure my framework/project works well in bolt?** | ||
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! | ||
- **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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Rename this file to .env once you have filled in the below environment variables! | ||
# Get your Anthropic API Key in your account settings - | ||
# https://console.anthropic.com/settings/keys | ||
# You only need this environment variable set if you want to use Claude models | ||
ANTHROPIC_API_KEY= | ||
|
||
# Include this environment variable if you want more logging for debugging locally | ||
VITE_LOG_LEVEL=debug |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "bolt", | ||
"description": "StackBlitz AI Agent", | ||
"description": "An AI Agent", | ||
"private": true, | ||
"license": "MIT", | ||
"packageManager": "[email protected]", | ||
|
@@ -15,6 +15,10 @@ | |
"lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .", | ||
"lint:fix": "npm run lint -- --fix", | ||
"start": "bindings=$(./bindings.sh) && wrangler pages dev ./build/client $bindings", | ||
"dockerstart": "bindings=$(./bindings.sh) && wrangler pages dev ./build/client $bindings --ip 0.0.0.0 --port 5173 --no-show-interactive-dev-session", | ||
"dockerrun": "docker run -it -d --name bolt-ai-live -p 5173:5173 --env-file .env.local bolt-ai", | ||
"dockerbuild:prod": "docker build -t bolt-ai:production -t bolt-ai:latest --target bolt-ai-production .", | ||
"dockerbuild": "docker build -t bolt-ai:development -t bolt-ai:latest --target bolt-ai-development .", | ||
"typecheck": "tsc", | ||
"typegen": "wrangler types", | ||
"preview": "pnpm run build && pnpm run start" | ||
|