Merge pull request #24 from swat-sccs/dcrepublic-dev

Merge Branding Changes

.github/workflows/main.yml

@@ -4,21 +4,21 @@ name: Mirror
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - uses: action-pack/gitlab-sync@v3
-      with:
-        # GitLab repo URL
-        url: https://gitlab.sccs.swarthmore.edu/sccs/scheduler.git
-        # GitLab username
-        username: mirrorbot
-        # GitLab token
-        token: ${{ secrets.GITLAB_TOKEN }}
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: action-pack/gitlab-sync@v3
+        with:
+          # GitLab repo URL
+          url: https://gitlab.sccs.swarthmore.edu/sccs/planner.git
+          # GitLab username
+          username: mirrorbot
+          # GitLab token
+          token: ${{ secrets.GITLAB_TOKEN }}

.gitlab-ci.yml

@@ -21,11 +21,11 @@ build:
   stage: build
   script:
     - docker compose -f docker-compose.yml build
-    - docker push $SCCS_REGISTRY/sccs/scheduler/scheduler:latest
+    - docker push $SCCS_REGISTRY/sccs/planner/planner:latest
 
 deploy_docker_stage:
   stage: deploy
   variables:
     DOCKER_HOST: "tcp://130.58.218.21:2376"
   script:
-    - docker stack deploy --with-registry-auth -c ./docker-compose.yml scheduler
+    - docker stack deploy --with-registry-auth -c ./docker-compose.yml planner

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+Thanks for considering contributing to Scheduler-V2!
+
+## Opening issues
+
+If you find a bug, please feel free to [open an issue](https://github.com/swat-sccs/scheduler-v2/issues).
+
+If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!
+
+## Fixing bugs
+
+We love pull requests. Here’s a quick guide:
+
+1. [Fork this repository](https://github.com/swat-sccs/scheduler-v2/fork) and then clone it locally:
+
+  ```bash
+   git clone --recursive https://github.com/swat-sccs/scheduler-v2.git
+  ```
+
+2. Create a topic branch for your changes:
+
+  ```bash
+  git checkout -b fix-for-that-thing
+  ```
+3. Commit a failing test for the bug:
+
+  ```bash
+  git commit -am "Adds a failing test to demonstrate that thing"
+  ```
+
+4. Commit a fix that makes the test pass:
+
+  ```bash
+  git commit -am "Adds a fix for that thing!"
+  ```
+
+6. If everything looks good, push to your fork:
+
+  ```bash
+  git push origin fix-for-that-thing
+  ```
+
+7. [Submit a pull request.](https://github.com/swat-sccs/scheduler-v2/pulls)
+
+
+## Adding new features
+
+Thinking of adding a new feature? Awesome! [open an issue](https://github.com/swat-sccs/scheduler-v2/issues). and let’s work on it together!

README.md

@@ -1,33 +1,57 @@
-# Scheduler v2
+<div align="center">
 
-## Technologies Used
+<img style="display:block; margin-left:auto; margin-right:auto; align:center;" src="./public/logo/logo.png" width="300" height="300"/>
 
-- [Next.js 14](https://nextjs.org/docs/getting-started)
-- [NextUI v2](https://nextui.org/)
-- [Tailwind CSS](https://tailwindcss.com/)
-- [Tailwind Variants](https://tailwind-variants.org)
-- [TypeScript](https://www.typescriptlang.org/)
-- [Framer Motion](https://www.framer.com/motion/)
-- [next-themes](https://github.com/pacocoursey/next-themes)
-- [Golang](https://go.dev/)
+<h1 style="text-align:center"> SCCS Course Planner</h1>
+
+<p  style="text-align:center"> The SCCS Course Planner is an all in one solution for planning your classes at Swarthmore College!</p>
+
+![repo_last_commit]
+[![License][repo_license_img]][repo_license_url]
+![repo_size]
+![build_status]
+
+<p>Looking to plan your classes? <a href="https://planner.sccs.swarthmore.edu/">Visit the live site!</a></p>
+</div>
 
-### Install dependencies
+## 🏁 Getting Started
 
-Install [Golang](https://go.dev/dl/)
+### Install
 
-Install [NodeJS](https://nodejs.org/en) v18.18 or higher
+<ul>
+
+[Golang](https://go.dev/dl/)
+
+[NodeJS](https://nodejs.org/en) v18.18 or higher
+
+[Docker](https://docs.docker.com/engine/install/)
+
+</ul>
+
+### Clone the Repo
 
-### Clone the Repo(recursivly!)
 ```bash
-  git clone --recursive https://github.com/swat-sccs/scheduler-v2.git
-  cd scheduler-v2
+  git clone --recursive https://github.com/swat-sccs/planner.git
+  git checkout dev
+  cd planner
 ```
 
 ### Configure your .env file
+
 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/planner_db"' > .env
+```
+
+Pase the following into a .env in the /swatscraper dir
+
+```bash
+  echo 'HOST=localhost
+        SQL_USER=postgres
+        PASS=example
+        DBNAME=planner_db
+        OPMODE="DEV"' > ./swatscraper/.env
 ```
 
 ### Run the development server
@@ -42,30 +66,40 @@ first run only:
 ```bash
 go mod init github.com/swatscraper
 go mod tidy
-```
-
-```bash
 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
 
-
-
 ### (Optional) View the database visually and in the browser!
 
 ```bash
 npx prisma studio
 ```
-Head on over to http://localhost:5555. Use this to confirm your database is populated. 
 
+Head on over to http://localhost:5555. Use this to confirm your database is populated.
+
+## 📡 Technologies in Use
 
+- [Next.js 14](https://nextjs.org/docs/getting-started)
+- [NextUI v2](https://nextui.org/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [Tailwind Variants](https://tailwind-variants.org)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Framer Motion](https://www.framer.com/motion/)
+- [next-themes](https://github.com/pacocoursey/next-themes)
+- [Golang](https://go.dev/)
 
 ## License
 
-Licensed under the [MIT license](https://github.com/swat-sccs/scheduler-v2/blob/main/LICENSE).
+Licensed under the [MIT license](https://github.com/swat-sccs/planner/blob/main/LICENSE).
+
+<!---vars-->
+
+[repo_license_img]: https://img.shields.io/badge/license-Mit-red?style=for-the-badge&logo=none
+[repo_license_url]: https://github.com/swat-sccs/planner?tab=MIT-1-ov-file#readme
+[repo_last_commit]: https://img.shields.io/github/last-commit/swat-sccs/planner?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Fswat-sccs%2Fplanner&color=%2343AA8B
+[build_status]: https://img.shields.io/github/check-runs/swat-sccs/planner/main?style=for-the-badge&label=Build&color=%2343AA8B
+[repo_size]: https://img.shields.io/github/repo-size/swat-sccs/planner?style=for-the-badge