From c86dc931df33b99f5dc6ce5dba2dfbd6037c0c0c Mon Sep 17 00:00:00 2001 From: Damian Rene <37555910+DCRepublic@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:29:24 -0500 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a265aed..11bb9b5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -
+
- +

SCCS Course Planner

@@ -28,7 +28,7 @@ -### Clone the Repo(recursivly!) +### Clone the Repo ```bash git clone --recursive https://github.com/swat-sccs/scheduler-v2.git @@ -40,9 +40,17 @@ Paste the following into a .env in the root of the project. -```env -DATABASE_URL="postgresql://postgres:example@localhost:5432/scheduler_db" +```bash +echo 'DATABASE_URL="postgresql://postgres:example@localhost:5432/scheduler_db"' > .env +``` +Pase the following into a .env in the /swatscraper dir +```bash + echo 'HOST=localhost + SQL_USER=postgres + PASS=example + DBNAME=scheduler_db + OPMODE="DEV"' > ./swatscraper/.env ``` ### Run the development server @@ -60,7 +68,7 @@ go mod tidy go run main.go -semester=spring -year=2025 # Change to semester of choice ``` -### View the dev site +## View the dev site Head on over to http://localhost:3000 @@ -72,7 +80,7 @@ npx prisma studio Head on over to http://localhost:5555. Use this to confirm your database is populated. -### 📡 Technologies in Use +## 📡 Technologies in Use - [Next.js 14](https://nextjs.org/docs/getting-started) - [NextUI v2](https://nextui.org/)