Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 19, 2025
2 parents 7af6754 + d62e211 commit 958c8a5
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 93 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ docker build . --target bolt-ai-development

**Option 3: Docker Compose Profile**
```bash
docker-compose --profile development up
docker compose --profile development up
```

#### Running the Development Container
Expand All @@ -171,7 +171,7 @@ docker build . --target bolt-ai-production

**Option 3: Docker Compose Profile**
```bash
docker-compose --profile production up
docker compose --profile production up
```

#### Running the Production Container
Expand Down
43 changes: 28 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@


# bolt.diy (Previously oTToDev)

[![bolt.diy: AI-Powered Full-Stack Web Development in the Browser](./public/social_preview_index.jpg)](https://bolt.diy)

Welcome to bolt.diy, the official open source version of Bolt.new (previously known as oTToDev and bolt.new ANY LLM), 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.

Check the [bolt.diy Docs](https://stackblitz-labs.github.io/bolt.diy/) for more information.
-----
Check the [bolt.diy Docs](https://stackblitz-labs.github.io/bolt.diy/) for more offical installation instructions and more informations.

-----
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 bolt.diy yourself!

We have also launched an experimental agent called the "bolt.diy Expert" that can answer common questions about bolt.diy. Find it here on the [oTTomator Live Agent Studio](https://studio.ottomator.ai/).
Expand Down Expand Up @@ -80,7 +83,7 @@ project, please check the [project management guide](./PROJECT.md) to get starte
- ✅ Together Integration (@mouimet-infinisoft)
- ✅ Mobile friendly (@qwikode)
- ✅ Better prompt enhancing (@SujalXplores)
- ✅ Attach images to prompts (@atrokhym)
- ✅ Attach images to prompts (@atrokhym)(@stijnus)
- ✅ Added Git Clone button (@thecodacus)
- ✅ Git Import from url (@thecodacus)
- ✅ PromptLibrary to have different variations of prompts for different use cases (@thecodacus)
Expand All @@ -101,34 +104,32 @@ project, please check the [project management guide](./PROJECT.md) to get starte
- ⬜ Voice prompting
- ⬜ Azure Open AI API Integration
- ⬜ Vertex AI Integration
- ⬜ Granite Integration
- ⬜ Popout Window for Web Container
- ⬜ Granite Integration
- ✅ Popout Window for Web Container(@stijnus)
- ✅ Ability to change Popout window size (@stijnus)

## Features

- **AI-powered full-stack web development** directly in your browser.
- **AI-powered full-stack web development** for **NodeJS based applications** 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.

## Setup
## Setup

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.
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.

Let's get you up and running with the stable version of Bolt.DIY!

## Quick Download

[![Download Latest Release](https://img.shields.io/github/v/release/stackblitz-labs/bolt.diy?label=Download%20Bolt&sort=semver)](https://github.com/stackblitz-labs/bolt.diy/releases/latest) ← Click here to go the the latest release version!
[![Download Latest Release](https://img.shields.io/github/v/release/stackblitz-labs/bolt.diy?label=Download%20Bolt&sort=semver)](https://github.com/stackblitz-labs/bolt.diy/releases/latest) ← Click here to go the the latest release version!

- Next **click source.zip**




## Prerequisites

Before you begin, you'll need to install two important pieces of software:
Expand Down Expand Up @@ -161,16 +162,19 @@ You have two options for running Bolt.DIY: directly on your machine or using Doc
### Option 1: Direct Installation (Recommended for Beginners)

1. **Install Package Manager (pnpm)**:

```bash
npm install -g pnpm
```

2. **Install Project Dependencies**:

```bash
pnpm install
```

3. **Start the Application**:

```bash
pnpm run dev
```
Expand All @@ -182,11 +186,13 @@ You have two options for running Bolt.DIY: directly on your machine or using Doc
This option requires some familiarity with Docker but provides a more isolated environment.

#### Additional Prerequisite

- Install Docker: [Download Docker](https://www.docker.com/)

#### Steps:

1. **Build the Docker Image**:

```bash
# Using npm script:
npm run dockerbuild
Expand All @@ -197,12 +203,9 @@ This option requires some familiarity with Docker but provides a more isolated e

2. **Run the Container**:
```bash
docker-compose --profile development up
docker compose --profile development up
```




## Configuring API Keys and Providers

### Adding Your API Keys
Expand Down Expand Up @@ -231,30 +234,35 @@ For providers that support custom base URLs (such as Ollama or LM Studio), follo
> **Note**: Custom base URLs are particularly useful when running local instances of AI models or using custom API endpoints.

### Supported Providers

- Ollama
- LM Studio
- OpenAILike

## Setup Using Git (For Developers only)

This method is recommended for developers who want to:

- Contribute to the project
- Stay updated with the latest changes
- Switch between different versions
- Create custom modifications

#### Prerequisites

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

#### Initial Setup

1. **Clone the Repository**:

```bash
# Using HTTPS
git clone https://github.com/stackblitz-labs/bolt.diy.git
```

2. **Navigate to Project Directory**:

```bash
cd bolt.diy
```
Expand All @@ -264,6 +272,7 @@ This method is recommended for developers who want to:
git checkout main
```
4. **Install Dependencies**:

```bash
pnpm install
```
Expand All @@ -278,16 +287,19 @@ This method is recommended for developers who want to:
To get the latest changes from the repository:

1. **Save Your Local Changes** (if any):

```bash
git stash
```

2. **Pull Latest Updates**:

```bash
git pull origin main
```

3. **Update Dependencies**:

```bash
pnpm install
```
Expand All @@ -302,6 +314,7 @@ To get the latest changes from the repository:
If you encounter issues:

1. **Clean Installation**:

```bash
# Remove node modules and lock files
rm -rf node_modules pnpm-lock.yaml
Expand Down
Loading

0 comments on commit 958c8a5

Please sign in to comment.