Merge branch 'main' into docs/updated-docs

README.md

@@ -87,119 +87,204 @@ bolt.diy was originally started by [Cole Medin](https://www.youtube.com/@ColeMed
 
 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.  
 
-### Prerequisites  
+Let's get you up and running with the stable version of Bolt.DIY!
 
-1. **Install Git**: [Download Git](https://git-scm.com/downloads)  
+## Quick Download
-2. **Install Node.js**: [Download Node.js](https://nodejs.org/en/download/)  
 
-   - After installation, the Node.js path is usually added to your system automatically. To verify:  
+[![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/download/bolt.diy.zip) ← Click here to download the latest version!
-     - **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.  
 
-### Clone the Repository
 
-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.
+## Prerequisites
 
-Clone the repository using Git:  
+Before you begin, you'll need to install two important pieces of software:
 
-```bash  
+### Install Node.js
-git clone -b stable https://github.com/stackblitz-labs/bolt.diy  
-```  
 
----
+Node.js is required to run the application.
 
-## Run the Application  
+1. Visit the [Node.js Download Page](https://nodejs.org/en/download/)
+2. Download the "LTS" (Long Term Support) version for your operating system
+3. Run the installer, accepting the default settings
+4. Verify Node.js is properly installed:
+   - **For Windows Users**:
+     1. Press `Windows + R`
+     2. Type "sysdm.cpl" and press Enter
+     3. Go to "Advanced" tab → "Environment Variables"
+     4. Check if `Node.js` appears in the "Path" variable
+   - **For Mac/Linux Users**:
+     1. Open Terminal
+     2. Type this command:
+        ```bash
+        echo $PATH
+        ```
+     3. Look for `/usr/local/bin` in the output
 
-### Option 1: Without Docker
+## Running the Application
 
-1. **Install Dependencies**:  
+You have two options for running Bolt.DIY: directly on your machine or using Docker.
-   ```bash  
-   pnpm install  
-   ```  
-   If `pnpm` is not installed, install it using:  
-   ```bash  
-   sudo npm install -g pnpm  
-   ```  
 
-2. **Start the Application**:  
+### Option 1: Direct Installation (Recommended for Beginners)
-   ```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.  
-
-### Option 2: With Docker  
-
-#### Prerequisites  
-- Ensure Git, Node.js, and Docker are installed: [Download Docker](https://www.docker.com/)  
-
-#### Steps  
-
-1. **Build the Docker Image**:  
-
-   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 
-   ```  
-
-   - With the development profile, changes to your code will automatically reflect in the running container (hot reloading).  
-
----
-
-### Entering API Keys
-
-All of your API Keys can be configured directly in the application. Just selecte the provider you want from the dropdown and click the pencile icon to enter your API key.
-
----
-
-### Update Your Local Version to the Latest
-
-To keep your local version of bolt.diy up to date with the latest changes, follow these steps for your operating system:
-
-#### 1. **Navigate to your project folder**  
-   Navigate to the directory where you cloned the repository and open a terminal:
-
-#### 2. **Fetch the Latest Changes**  
-   Use Git to pull the latest changes from the main repository:
 
+1. **Install Package Manager (pnpm)**:
    ```bash
-   git pull origin main
+   npm install -g pnpm
    ```
 
-#### 3. **Update Dependencies**  
+2. **Install Project Dependencies**:
-   After pulling the latest changes, update the project dependencies by running the following command:
-
    ```bash
    pnpm install
    ```
 
-#### 4. **Rebuild and Start the Application**  
+3. **Start the Application**:
+   ```bash
+   pnpm run dev
+   ```
 
-   - **If using Docker**, ensure you rebuild the Docker image to avoid using a cached version:  
+   **Important Note**: If you're using Google Chrome, you'll need Chrome Canary for local development. [Download it here](https://www.google.com/chrome/canary/)
-     ```bash  
-     docker-compose --profile development up --build  
-     ```  
 
-   - **If not using Docker**, you can start the application as usual with:  
+### Option 2: Using Docker
-     ```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. 
+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
+
+   # OR using direct Docker command:
+   docker build . --target bolt-ai-development
+   ```
+
+2. **Run the Container**:
+   ```bash
+   docker-compose --profile development up
+   ```
+
+
+
+
+## Configuring API Keys and Providers
+
+### Adding Your API Keys
+
+Setting up your API keys in Bolt.DIY is straightforward:
+
+1. Open the home page (main interface)
+2. Select your desired provider from the dropdown menu
+3. Click the pencil (edit) icon
+4. Enter your API key in the secure input field
+
+![API Key Configuration Interface](./docs/images/api-key-ui-section.png)
+
+### Configuring Custom Base URLs
+
+For providers that support custom base URLs (such as Ollama or LM Studio), follow these steps:
+
+1. Click the settings icon in the sidebar to open the settings menu
+   ![Settings Button Location](./docs/images/bolt-settings-button.png)
+
+2. Navigate to the "Providers" tab
+3. Search for your provider using the search bar
+4. Enter your custom base URL in the designated field
+   ![Provider Base URL Configuration](./docs/images/provider-base-url.png)
+
+> **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
+   ```
+
+3. **Switch to the Main Branch**:
+   ```bash
+   git checkout main
+   ```
+4. **Install Dependencies**:
+   ```bash
+   pnpm install
+   ```
+
+5. **Start the Development Server**:
+   ```bash
+   pnpm run dev
+   ```
+
+#### Staying Updated
+
+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
+   ```
+
+4. **Restore Your Local Changes** (if any):
+   ```bash
+   git stash pop
+   ```
+
+#### Troubleshooting Git Setup
+
+If you encounter issues:
+
+1. **Clean Installation**:
+   ```bash
+   # Remove node modules and lock files
+   rm -rf node_modules pnpm-lock.yaml
+
+   # Clear pnpm cache
+   pnpm store prune
+
+   # Reinstall dependencies
+   pnpm install
+   ```
+
+2. **Reset Local Changes**:
+   ```bash
+   # Discard all local changes
+   git reset --hard origin/main
+   ```
+
+Remember to always commit your local changes or stash them before pulling updates to avoid conflicts.
 
 ---
 

app/commit.json

@@ -1 +1 @@
-{ "commit": "636f87f568a368dadc5cf3c077284710951e2488", "version": "0.0.3" }
+{ "commit": "ab5cde30a126f6540f0afb4d6d6e6be6a764ddca", "version": "0.0.3" }