Skip to content

Commit 2210712

Browse files
docs: clarify deployment steps (#17)
1 parent 575178f commit 2210712

File tree

1 file changed

+42
-6
lines changed

1 file changed

+42
-6
lines changed

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,39 @@ A code agent task management system that provides parallel execution of AI-power
2727
- **Agents**: Claude Code (Anthropic) with extensible support for other models
2828
- **Task Management**: Parallel execution system based on container
2929

30+
## Prerequisites
31+
32+
- Docker and Docker Compose installed
33+
- (Optional) Supabase account for persistent data storage
34+
3035
## Quick Start
3136

32-
1. **Setup**
37+
1. **Clone the repository**
3338
```bash
3439
git clone <this-repo>
3540
cd async-code
36-
./build.sh
3741
```
3842

39-
2. **Configure**
40-
- Add your Anthropic API key to `server/.env`
41-
- Get a GitHub Personal Access Token with repo permissions
43+
2. **Create the environment file**
44+
```bash
45+
cp server/.env.example server/.env
46+
```
47+
Edit `server/.env` and set your `ANTHROPIC_API_KEY`. If you are using Supabase, also set `SUPABASE_URL`, `SUPABASE_ANON_KEY` and `SUPABASE_SERVICE_ROLE_KEY`.
48+
49+
3. **Build and start the stack**
50+
```bash
51+
docker-compose up --build -d
52+
```
4253

43-
3. **Run**
4454
- Frontend: http://localhost:3000
4555
- Backend API: http://localhost:5000
4656

57+
## Supabase Setup
58+
59+
1. Create a new project in the [Supabase](https://supabase.com) dashboard.
60+
2. Open the SQL editor and run `db/init_supabase.sql` to create the required tables.
61+
3. Grab your project URL, anon key and service role key from **Project Settings → API** and place them in `server/.env`.
62+
4763
## Usage
4864

4965
1. **Setup GitHub Token**: Enter your GitHub token in the web interface
@@ -58,7 +74,15 @@ A code agent task management system that provides parallel execution of AI-power
5874
```bash
5975
# server/.env
6076
ANTHROPIC_API_KEY=your_anthropic_api_key_here
77+
78+
# Supabase
79+
SUPABASE_URL=https://your-project.supabase.co
80+
SUPABASE_ANON_KEY=your_anon_key
81+
SUPABASE_SERVICE_ROLE_KEY=your_service_role_key
82+
83+
# Flask configuration
6184
FLASK_ENV=production
85+
FLASK_DEBUG=False
6286
```
6387

6488

@@ -73,6 +97,18 @@ cd async-code-web && npm run dev # Frontend
7397
cd server && python main.py # Backend
7498
```
7599

100+
## Production Deployment
101+
102+
1. Set `FLASK_ENV=production` in `server/.env` and export `NODE_ENV=production` before running the stack.
103+
2. Build and start the containers:
104+
```bash
105+
NODE_ENV=production docker-compose up --build -d
106+
```
107+
3. Monitor the logs with:
108+
```bash
109+
docker-compose logs -f
110+
```
111+
76112

77113
## License
78114

0 commit comments

Comments
 (0)