Alexander Berger
commited on
Commit
·
0128b0a
1
Parent(s):
135c5c5
chore: update readme
Browse files
README.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1 |
-
# Bolt
|
2 |
-
Welcome to the **Bolt** open-source
|
3 |
|
4 |
### Why Build with Bolt + WebContainer API
|
5 |
By building with the Bolt + WebContainer API you can create browser-based applications that let users **prompt, run, edit, and deploy** full-stack web apps directly in the browser, without the need for virtual machines. With WebContainer API, you can build apps that give AI direct access and full control over a **Node.js server**, **filesystem**, **package manager** and **dev terminal** inside your users browser tab. This powerful combination allows you to create a new class of development tools that support all major javascript libraries and node packages right out of the box, all without remote environments or local installs.
|
@@ -11,9 +11,39 @@ By building with the Bolt + WebContainer API you can create browser-based applic
|
|
11 |
|
12 |
- **Bolt (This Repo)**: This open-source repository provides the building blocks behind **Bolt.new**. This package contains the UI interface for Bolt as well as the server components, built using [Remix Run](https://remix.run/). By leveraging this repo and StackBlitz’s **WebContainer API**, you can create your own AI-powered development tools and full-stack applications that run entirely in the browser. This code allows you to customize and expand use cases, integrating AI and WebContainers into your own unique applications.
|
13 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
14 |
The [WebContainer API](https://webcontainers.io) is free for personal and open source usage. If you're building an application for commercial usage, you can learn more about our [WebContainer API commercial usage pricing here](https://stackblitz.com/pricing#webcontainer-api).
|
15 |
|
16 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
17 |
|
18 |
## Prerequisites
|
19 |
|
@@ -88,35 +118,3 @@ pnpm run deploy
|
|
88 |
```
|
89 |
|
90 |
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
|
91 |
-
|
92 |
-
## Getting Started
|
93 |
-
|
94 |
-
Bolt combines the capabilities of AI with sandboxed development environments
|
95 |
-
to create a collaborative experience where code can be developed by the
|
96 |
-
assistant and the programmer together. Bolt combines
|
97 |
-
[WebContainer API](https://webcontainers.io/api) with
|
98 |
-
[Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet)
|
99 |
-
using [Remix](https://remix.run/) and the [AI SDK](https://sdk.vercel.ai/).
|
100 |
-
|
101 |
-
### WebContainer API
|
102 |
-
|
103 |
-
Bolt uses [WebContainers](https://webcontainers.io/) to run generated code in
|
104 |
-
the browser. WebContainers provide Bolt with a full-stack sandbox environment
|
105 |
-
using [WebContainer API](https://webcontainers.io/api). WebContainer run full-
|
106 |
-
stack applications directly in the browser without the cost and security
|
107 |
-
concerns of cloud hosted AI agents. WebContainers are interactive and editable,
|
108 |
-
and enables Bolt's AI to run code and understand any changes from the user.
|
109 |
-
Take a look at how [Bolt integrates with WebContainer API](https://github.com/search?q=repo%3Astackblitz%2Fbolt-oss%20%40webcontainer%2Fapi&type=code).
|
110 |
-
|
111 |
-
### Remix App
|
112 |
-
|
113 |
-
Bolt is built with [Remix](https://remix.run/) and
|
114 |
-
deployed using [CloudFlare Pages](https://pages.cloudflare.com/) and
|
115 |
-
[CloudFlare Workers](https://workers.cloudflare.com/).
|
116 |
-
|
117 |
-
### AI SDK Integration
|
118 |
-
|
119 |
-
Bolt uses the [AI SDK](https://github.com/vercel/ai) to integrate with AI
|
120 |
-
models. At this time, Bolt supports using Anthropic's Claude Sonnet 3.5.
|
121 |
-
You can get an API key from the [Anthropic API Console](https://console.anthropic.com/) to use with Bolt.
|
122 |
-
Take a look at how [Bolt uses the AI SDK](https://github.com/stackblitz/bolt-oss/tree/main/app/lib/.server/llm)
|
|
|
1 |
+
# Bolt Open Source Codebase
|
2 |
+
Welcome to the **Bolt** open-source codebase! This repo provides everything you need to start building **AI-powered software development tools** powered by StackBlitz’s **WebContainer API**.
|
3 |
|
4 |
### Why Build with Bolt + WebContainer API
|
5 |
By building with the Bolt + WebContainer API you can create browser-based applications that let users **prompt, run, edit, and deploy** full-stack web apps directly in the browser, without the need for virtual machines. With WebContainer API, you can build apps that give AI direct access and full control over a **Node.js server**, **filesystem**, **package manager** and **dev terminal** inside your users browser tab. This powerful combination allows you to create a new class of development tools that support all major javascript libraries and node packages right out of the box, all without remote environments or local installs.
|
|
|
11 |
|
12 |
- **Bolt (This Repo)**: This open-source repository provides the building blocks behind **Bolt.new**. This package contains the UI interface for Bolt as well as the server components, built using [Remix Run](https://remix.run/). By leveraging this repo and StackBlitz’s **WebContainer API**, you can create your own AI-powered development tools and full-stack applications that run entirely in the browser. This code allows you to customize and expand use cases, integrating AI and WebContainers into your own unique applications.
|
13 |
|
14 |
+
# Get Started Building with Bolt
|
15 |
+
|
16 |
+
Bolt combines the capabilities of AI with sandboxed development environments
|
17 |
+
to create a collaborative experience where code can be developed by the
|
18 |
+
assistant and the programmer together. Bolt combines
|
19 |
+
[WebContainer API](https://webcontainers.io/api) with
|
20 |
+
[Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet)
|
21 |
+
using [Remix](https://remix.run/) and the [AI SDK](https://sdk.vercel.ai/).
|
22 |
+
|
23 |
+
### WebContainer API
|
24 |
+
|
25 |
+
Bolt uses [WebContainers](https://webcontainers.io/) to run generated code in
|
26 |
+
the browser. WebContainers provide Bolt with a full-stack sandbox environment
|
27 |
+
using [WebContainer API](https://webcontainers.io/api). WebContainers run full-
|
28 |
+
stack applications directly in the browser without the cost and security
|
29 |
+
concerns of cloud hosted AI agents. WebContainers are interactive and editable,
|
30 |
+
and enables Bolt's AI to run code and understand any changes from the user.
|
31 |
+
|
32 |
The [WebContainer API](https://webcontainers.io) is free for personal and open source usage. If you're building an application for commercial usage, you can learn more about our [WebContainer API commercial usage pricing here](https://stackblitz.com/pricing#webcontainer-api).
|
33 |
|
34 |
+
### Remix App
|
35 |
+
|
36 |
+
Bolt is built with [Remix](https://remix.run/) and
|
37 |
+
deployed using [CloudFlare Pages](https://pages.cloudflare.com/) and
|
38 |
+
[CloudFlare Workers](https://workers.cloudflare.com/).
|
39 |
+
|
40 |
+
### AI SDK Integration
|
41 |
+
|
42 |
+
Bolt uses the [AI SDK](https://github.com/vercel/ai) to integrate with AI
|
43 |
+
models. At this time, Bolt supports using Anthropic's Claude Sonnet 3.5.
|
44 |
+
You can get an API key from the [Anthropic API Console](https://console.anthropic.com/) to use with Bolt.
|
45 |
+
Take a look at how [Bolt uses the AI SDK](https://github.com/stackblitz/bolt-oss/tree/main/app/lib/.server/llm)
|
46 |
+
|
47 |
|
48 |
## Prerequisites
|
49 |
|
|
|
118 |
```
|
119 |
|
120 |
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|