Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DCRepublic authored Nov 21, 2024
1 parent 345d589 commit c86dc93
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div style="align:center; text-align:center;">
<div align="center">

<img style="display:block; margin-left:auto; margin-right:auto;" src="./public/logo/logo.png" width="300" height="300"/>
<img style="display:block; margin-left:auto; margin-right:auto; align:center;" src="./public/logo/logo.png" width="300" height="300"/>

<h1 style="text-align:center"> SCCS Course Planner</h1>

Expand Down Expand Up @@ -28,7 +28,7 @@

</ul>

### Clone the Repo(recursivly!)
### Clone the Repo

```bash
git clone --recursive https://github.com/swat-sccs/scheduler-v2.git
Expand All @@ -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
Expand All @@ -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

Expand All @@ -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/)
Expand Down

0 comments on commit c86dc93

Please sign in to comment.