Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

docs(frontend): update README with Docker instructions (#10648)

Ubbe9158d4b6a2e7
diff --git a/autogpt_platform/frontend/README.md b/autogpt_platform/frontend/README.md
index c0b14448a5..1d9ebff269 100644
--- a/autogpt_platform/frontend/README.md
+++ b/autogpt_platform/frontend/README.md
@@ -18,31 +18,58 @@ Make sure you have Node.js 16.10+ installed. Corepack is included with Node.js b
>
> Then follow the setup steps below.
-### Setup
+## Setup
-1. **Enable corepack** (run this once on your system):
+### 1. **Enable corepack** (run this once on your system):
- ```bash
- corepack enable
- ```
+```bash
+corepack enable
+```
- This enables corepack to automatically manage pnpm based on the `packageManager` field in `package.json`.
+This enables corepack to automatically manage pnpm based on the `packageManager` field in `package.json`.
-2. **Install dependencies**:
+### 2. **Install dependencies**:
- ```bash
- pnpm i
- ```
+```bash
+pnpm i
+```
-3. **Start the development server**:
- ```bash
- pnpm dev
- ```
+### 3. **Start the development server**:
+
+#### Running the Front-end & Back-end separately
+
+We recommend this approach if you are doing active development on the project. First spin up the Back-end:
+
+```bash
+# on `autogpt_platform`
+docker compose --profile local up deps_backend -d
+# on `autogpt_platform/backend`
+poetry run app
+```
+
+Then start the Front-end:
+
+```bash
+# on `autogpt_platform/frontend`
+pnpm dev
+```
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. If the server starts on `http://localhost:3001` it means the Front-end is already running via Docker. You have to kill the container then or do `docker compose down`.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+#### Running both the Front-end and Back-end via Docker
+
+If you run:
+
+```bash
+# on `autogpt_platform`
+docker compose up -d
+```
+
+It will spin up the Back-end and Front-end via Docker. The Front-end will start on port `3000`. This might not be
+what you want when actively contributing to the Front-end as you won't have direct/easy access to the Next.js dev server.
+
### Subsequent Runs
For subsequent development sessions, you only need to run: