forked from code100x/daily-code
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve README formatting and structure
Co-Authored-By: Harkirat Singh <[email protected]>
- Loading branch information
1 parent
363e591
commit 7d5a5d7
Showing
1 changed file
with
15 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |