Skip to content

Commit f0f7173

Browse files
committed
chore: docker update
1 parent a8c4733 commit f0f7173

File tree

2 files changed

+66
-46
lines changed

2 files changed

+66
-46
lines changed

README.md

Lines changed: 65 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,69 @@ Built with ⚡ **Bun** for fast runtime performance.
2626

2727
---
2828

29+
## 🐳 Running with Docker (Recommended for users)
30+
31+
### 1. Using Docker Compose (Recommended)
32+
Ensure you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed and docker engine is running on your machine.
33+
34+
Prepare your `.env` file:
35+
36+
```bash
37+
# PROJECT TOOLS API TOKENS
38+
SECRET_LINEAR_API_KEY="Your linear api key"
39+
40+
# AI API TOKENS
41+
SECRET_GEMINI_API_KEY="Your gemini api key"
42+
SECRET_GROQ_API_KEY="Your groq api key"
43+
44+
# Local inference
45+
INFERENCE_SERVER_URL=http://127.0.0.1:1234
46+
INFERENCE_SERVER_URL_DOCKER=http://host.docker.internal:1234
47+
48+
```
49+
50+
Use the provided `docker-compose.yml` or create one like this in the same directory as your .env file:
51+
52+
```yaml
53+
services:
54+
autoproject:
55+
container_name: autoproject_app
56+
image: xqbuilds/autoproject:latest
57+
pull_policy: always
58+
ports:
59+
- "3000:3000"
60+
env_file:
61+
- .env
62+
environment:
63+
NODE_ENV: production
64+
DOCKER_ENV: true
65+
restart: unless-stopped
66+
```
67+
68+
Run:
69+
70+
```bash
71+
docker compose up -d
72+
```
73+
74+
Access the app at [http://localhost:3000](http://localhost:3000).
75+
76+
To stop the container, you can use:
77+
78+
```bash
79+
docker compose stop
80+
```
81+
82+
For a clean reset to remove the container and its data, you can use:
83+
84+
```bash
85+
docker compose down
86+
```
87+
88+
With this approach, you do not need to fork the repo and setup any development environment. All you need are the API keys, .env file, and the Docker Compose file.
89+
90+
---
91+
2992
## 🚀 Getting Started (Development Mode)
3093

3194
### Prerequisites
@@ -39,7 +102,7 @@ Built with ⚡ **Bun** for fast runtime performance.
39102

40103
---
41104

42-
### 1. Local Development Setup
105+
### Local Development Setup
43106

44107
Clone and install dependencies:
45108

@@ -66,7 +129,7 @@ Access the app at [http://localhost:5173](http://localhost:5173).
66129

67130
---
68131

69-
## 🔥 Running in Production Mode
132+
### 🔥 Running in Production Mode
70133

71134
Build the app:
72135

@@ -85,50 +148,6 @@ Access it at [http://localhost:4173](http://localhost:4173).
85148

86149
---
87150

88-
## 🐳 Running with Docker
89-
90-
### 1. Using Docker Compose (Recommended)
91-
92-
Prepare your `.env` file:
93-
94-
```bash
95-
cp .env.example .env
96-
# Fill in your API keys
97-
```
98-
99-
Use the provided `docker-compose.yml` or create one like this:
100-
101-
```yaml
102-
services:
103-
autoproject:
104-
image: xqbuilds/autoproject:latest
105-
ports:
106-
- "3000:3000"
107-
env_file:
108-
- .env
109-
environment:
110-
NODE_ENV: production
111-
restart: unless-stopped
112-
```
113-
114-
Run:
115-
116-
```bash
117-
docker-compose up -d
118-
```
119-
120-
Access the app at [http://localhost:3000](http://localhost:3000).
121-
122-
---
123-
124-
### 2. Running Manually Without Compose
125-
126-
```bash
127-
docker run --env-file .env -p 3000:3000 xqbuilds/autoproject:latest
128-
```
129-
130-
---
131-
132151
## 📜 Environment Variables
133152

134153
| Variable | Required | Description |

autoproject/docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ services:
22
autoproject:
33
container_name: autoproject_app
44
image: xqbuilds/autoproject:latest
5+
pull_policy: always
56
ports:
67
- "3000:3000"
78
env_file:

0 commit comments

Comments
 (0)