Skip to content

Commit 50ebe9f

Browse files
committed
docs: Update README to clarify Docker Compose usage and reformat steps
1 parent 92b6b49 commit 50ebe9f

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,16 @@
1111
#### Requirements:
1212

1313
- [Bun](https://bun.sh/)
14-
- [RabbitMQ Server](https://www.rabbitmq.com/)
15-
- [Redis Server](https://redis.io/)
14+
- [RabbitMQ Server](https://www.rabbitmq.com/) (already included in Docker Compose)
15+
- [Redis Server](https://redis.io/) (already included in Docker Compose)
1616

17-
#### 1. Configure the environment variables:
17+
#### 1. Starting services with Docker Compose: (Optional)
18+
19+
```bash
20+
docker compose up --profiles services up -d
21+
```
22+
23+
#### 2. Configure the environment variables:
1824

1925
Copy the `.env.example` file to `.env` for production or `.env.development` for development and fill the necessary variables with the appropriate values.
2026

@@ -30,25 +36,25 @@ cp .env.example .env
3036
cp .env.example .env.development
3137
```
3238

33-
#### 2. Install the dependencies:
39+
#### 3. Install the dependencies:
3440

3541
```bash
3642
bun install
3743
```
3844

39-
#### 3. Run the project in development mode:
45+
#### 4. Run the project in development mode:
4046

4147
```bash
4248
bun dev
4349
```
4450

45-
#### 4. Build the project:
51+
#### 5. Build the project:
4652

4753
```bash
4854
bun run build
4955
```
5056

51-
#### 5. Run the project in production mode:
57+
#### 6. Run the project in production mode:
5258

5359
```bash
5460
bun start

0 commit comments

Comments
 (0)