Skip to content

Commit

Permalink
docs: added info on both ways to set api keys
Browse files Browse the repository at this point in the history
  • Loading branch information
@dustinwloring1988
dustinwloring1988 committed Dec 20, 2024
1 parent 0c07bc9 commit ed5bad3
Showing 1 changed file with 121 additions and 98 deletions.
219 changes: 121 additions & 98 deletions docs/docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@ bolt.diy allows you to choose the LLM that you use for each prompt! Currently, y

## Table of Contents
- [Join the community!](#join-the-community)
- [What's bolt.diy](#whats-boltdiy)
- [What Makes bolt.diy Different](#what-makes-boltdiy-different)
- [Features](#features)
- [Setup](#setup)
- [Run with Docker](#run-with-docker)
- [Using Helper Scripts](#1a-using-helper-scripts)
- [Direct Docker Build Commands](#1b-direct-docker-build-commands-alternative-to-using-npm-scripts)
- [Docker Compose with Profiles](#2-docker-compose-with-profiles-to-run-the-container)
- [Run Without Docker](#run-without-docker)
- [Prerequisites](#prerequisites)
- [Clone the Repository](#clone-the-repository)
- [Entering API Keys](#entering-api-keys)
- [1. Set API Keys in the `.env.local` File](#1-set-api-keys-in-the-envlocal-file)
- [2. Configure API Keys Directly in the Application](#2-configure-api-keys-directly-in-the-application)
- [Run the Application](#run-the-application)
- [Option 1: Without Docker](#option-1-without-docker)
- [Option 2: With Docker](#option-2-with-docker)
- [Update Your Local Version to the Latest](#update-your-local-version-to-the-latest)
- [Adding New LLMs](#adding-new-llms)
- [Available Scripts](#available-scripts)
- [Development](#development)
Expand All @@ -24,154 +27,174 @@ bolt.diy allows you to choose the LLM that you use for each prompt! Currently, y

---

## Whats bolt.diy
## Features

bolt.diy 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)
- **AI-powered full-stack web development** directly in your browser.
- **Support for multiple LLMs** with an extensible architecture to integrate additional models.
- **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.
- **Integration-ready Docker support** for a hassle-free setup.

---

## What Makes bolt.diy Different
## Setup

Claude, v0, etc are incredible- but you can't install packages, run backends, or edit code. That’s where bolt.diy stands out:
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.

- **Full-Stack in the Browser**: bolt.diy 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
### Prerequisites

- **AI with Environment Control**: Unlike traditional dev environments where the AI can only assist in code generation, bolt.diy 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 whole app lifecycle—from creation to deployment.
1. **Install Git**: [Download Git](https://git-scm.com/downloads)
2. **Install Node.js**: [Download Node.js](https://nodejs.org/en/download/)

Whether you’re an experienced developer, a PM, or a designer, bolt.diy allows you to easily build production-grade full-stack applications.
- After installation, the Node.js path is usually added to your system automatically. To verify:
- **Windows**: Search for "Edit the system environment variables," click "Environment Variables," and check if `Node.js` is in the `Path` variable.
- **Mac/Linux**: Open a terminal and run:
```bash
echo $PATH
```
Look for `/usr/local/bin` in the output.

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

---

## Setup

Many of you are new users to installing software from Github. If you have any installation troubles reach out and submit an "issue" using the links above, or feel free to enhance this documentation by forking, editing the instructions, and doing a pull request.

1. [Install Git from](https://git-scm.com/downloads)

2. [Install Node.js from](https://nodejs.org/en/download/)
Alternatively, you can download the latest version of the project directly from the [Releases Page](https://github.com/stackblitz-labs/bolt.diy/releases/latest). Simply download the .zip file, extract it, and proceed with the setup instructions below. If you are comfertiable using git then run the command below.

Pay attention to the installer notes after completion.
Clone the repository using Git:

On all operating systems, the path to Node.js should automatically be added to your system path. But you can check your path if you want to be sure. On Windows, you can search for "edit the system environment variables" in your system, select "Environment Variables..." once you are in the system properties, and then check for a path to Node in your "Path" system variable. On a Mac or Linux machine, it will tell you to check if /usr/local/bin is in your $PATH. To determine if usr/local/bin is included in $PATH open your Terminal and run:

```
echo $PATH .
```bash
git clone -b stable https://github.com/stackblitz-labs/bolt.diy
```

If you see usr/local/bin in the output then you're good to go.
---

3. Clone the repository (if you haven't already) by opening a Terminal window (or CMD with admin permissions) and then typing in this:
### Entering API Keys

```
git clone https://github.com/stackblitz-labs/bolt.diy.git
```
There are two ways to configure your API keys in bolt.diy:

3. Rename .env.example to .env.local and add your LLM API keys. You will find this file on a Mac at "[your name]/bolt.diy/.env.example". For Windows and Linux the path will be similar.
#### 1. Set API Keys in the `.env.local` File

![image](https://github.com/user-attachments/assets/7e6a532c-2268-401f-8310-e8d20c731328)
When setting up the application, you will need to add your API keys for the LLMs you wish to use. You can do this by renaming the `.env.example` file to `.env.local` and adding your API keys there.

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.
- On **Mac**, you can find the file at `[your name]/bolt.diy/.env.example`.
- On **Windows/Linux**, the path will be similar.

```
If you can't see the file, it's likely because hidden files are not being shown. On **Mac**, open a Terminal window and enter the following command to show hidden files:

```bash
defaults write com.apple.finder AppleShowAllFiles YES
```

**NOTE**: you only have to set the ones you want to use and Ollama doesn't need an API key because it runs locally on your computer:

[Get your GROQ API Key here](https://console.groq.com/keys)

[Get your Open AI API Key by following these instructions](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key)

Get your Anthropic API Key in your [account settings](https://console.anthropic.com/settings/keys)
Make sure to add your API keys for each provider you want to use, for example:

```
GROQ_API_KEY=XXX
OPENAI_API_KEY=XXX
ANTHROPIC_API_KEY=XXX
```

Optionally, you can set the debug level:
Once you've set your keys, you can proceed with running the app. You will set these keys up during the initial setup, and you can revisit and update them later after the app is running.
```
VITE_LOG_LEVEL=debug
```
**Note**: Never commit your `.env.local` file to version control. It’s already included in the `.gitignore`.
**Important**: Never commit your `.env.local` file to version control. It's already included in .gitignore.
#### 2. Configure API Keys Directly in the Application
## Run with Docker
Alternatively, you can configure your API keys directly in the application once it's running. To do this:

Prerequisites:
1. Launch the application and navigate to the provider selection dropdown.
2. Select the provider you wish to configure.
3. Click the pencil icon next to the selected provider.
4. Enter your API key in the provided field.

Git and Node.js as mentioned above, as well as Docker: https://www.docker.com/
This method allows you to easily add or update your keys without needing to modify files directly.

### 1a. Using Helper Scripts
Once you've configured your keys, the application will be ready to use the selected LLMs.
NPM scripts are provided for convenient building:
```bash
# Development build
npm run dockerbuild
---
# Production build
npm run dockerbuild:prod
```
## Run the Application
### 1b. Direct Docker Build Commands (alternative to using NPM scripts)
### Option 1: Without Docker
You can use Docker's target feature to specify the build environment instead of using NPM scripts if you wish:
1. **Install Dependencies**:
```bash
pnpm install
```
If `pnpm` is not installed, install it using:
```bash
sudo npm install -g pnpm
```
```bash
# Development build
docker build . --target bolt-ai-development
2. **Start the Application**:
```bash
pnpm run dev
```
This will start the Remix Vite development server. You will need Google Chrome Canary to run this locally if you use Chrome! It's an easy install and a good browser for web development anyway.

# Production build
docker build . --target bolt-ai-production
```
### Option 2: With Docker

### 2. Docker Compose with Profiles to Run the Container
#### Prerequisites
- Ensure Git, Node.js, and Docker are installed: [Download Docker](https://www.docker.com/)

Use Docker Compose profiles to manage different environments:
#### Steps

```bash
# Development environment
docker-compose --profile development up
1. **Build the Docker Image**:

# Production environment
docker-compose --profile production up
```
Use the provided NPM scripts:
```bash
npm run dockerbuild
```

Alternatively, use Docker commands directly:
```bash
docker build . --target bolt-ai-development
```

2. **Run the Container**:
Use Docker Compose profiles to manage environments:
```bash
docker-compose --profile development 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!).
- With the development profile, changes to your code will automatically reflect in the running container (hot reloading).

---

## Run Without Docker
### Update Your Local Version to the Latest

1. Install dependencies using Terminal (or CMD in Windows with admin permissions):
To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:

```
pnpm install
```
#### 1. **Navigate to your project folder**
Navigate to the directory where you cloned the repository and open a terminal:

If you get an error saying "command not found: pnpm" or similar, then that means pnpm isn't installed. You can install it via this:
#### 2. **Fetch the Latest Changes**
Use Git to pull the latest changes from the main repository:

```
sudo npm install -g pnpm
```
```bash
git pull origin main
```

2. Start the application with the command:
#### 3. **Update Dependencies**
After pulling the latest changes, update the project dependencies by running the following command:

```bash
pnpm run dev
```
```bash
pnpm install
```

#### 4. **Rebuild and Start the Application**

- **If using Docker**, ensure you rebuild the Docker image to avoid using a cached version:
```bash
docker-compose --profile development up --build
```

- **If not using Docker**, you can start the application as usual with:
```bash
pnpm run dev
```

This ensures that you're running the latest version of bolt.diy and can take advantage of all the newest features and bug fixes.
---
Expand Down

0 comments on commit ed5bad3

Please sign in to comment.