Skip to content

Commit

Permalink
docs: improve README formatting and structure
Browse files Browse the repository at this point in the history
Co-Authored-By: Harkirat Singh <[email protected]>
  • Loading branch information
devin-ai-integration[bot] and hkirat committed Dec 11, 2024
1 parent 363e591 commit 7d5a5d7
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
# Quick Setup Locally

* Docker
## Option 1: Using Docker

```
```bash
docker compose watch
```

OR

> Install the Dependencies
## Option 2: Manual Setup

```
### 1. Install Dependencies
```bash
cd daily-code
yarn install
```

> Setup DB
For Mac and Linux users
```
### 2. Setup Database

#### For Mac and Linux users
```bash
cd packages/db
chmod +x ./setupDB.sh
./setupDB.sh
```

For Windows users (using docker to start db locally)
```
#### For Windows users
```bash
cd packages/db
copy .env.example .env
docker-compose up

now, write the connection string in DATABASE_URL
# Configure the database connection
# Add your connection string to DATABASE_URL

yarn prisma migrate dev
yarn prisma db seed
```

> Run locally
```
### 3. Run Locally
```bash
cd ../..
yarn run dev
```

0 comments on commit 7d5a5d7

Please sign in to comment.