From 7d5a5d75d0a86f143d4b2855c8aa5737035e62f1 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 18:54:57 +0000 Subject: [PATCH] docs: improve README formatting and structure Co-Authored-By: Harkirat Singh --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c88436bd..ee074eff 100644 --- a/README.md +++ b/README.md @@ -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 ```