Skip to content

Commit 57716fb

Browse files
authored
Merge pull request #701 from code100x/devin/1733943191-update-readme-formatting
docs: improve README formatting and structure
2 parents 363e591 + 7d5a5d7 commit 57716fb

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
# Quick Setup Locally
22

3-
* Docker
3+
## Option 1: Using Docker
44

5-
```
5+
```bash
66
docker compose watch
77
```
88

9-
OR
10-
11-
> Install the Dependencies
9+
## Option 2: Manual Setup
1210

13-
```
11+
### 1. Install Dependencies
12+
```bash
1413
cd daily-code
1514
yarn install
1615
```
1716

18-
> Setup DB
19-
For Mac and Linux users
20-
```
17+
### 2. Setup Database
18+
19+
#### For Mac and Linux users
20+
```bash
2121
cd packages/db
2222
chmod +x ./setupDB.sh
2323
./setupDB.sh
2424
```
2525

26-
For Windows users (using docker to start db locally)
27-
```
26+
#### For Windows users
27+
```bash
2828
cd packages/db
2929
copy .env.example .env
3030
docker-compose up
3131

32-
now, write the connection string in DATABASE_URL
32+
# Configure the database connection
33+
# Add your connection string to DATABASE_URL
3334

3435
yarn prisma migrate dev
3536
yarn prisma db seed
3637
```
3738

38-
> Run locally
39-
40-
```
39+
### 3. Run Locally
40+
```bash
4141
cd ../..
4242
yarn run dev
4343
```

0 commit comments

Comments
 (0)