Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve README formatting and structure #701

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```
Loading