Merge branch 'main' of https://github.com/WPI-Roadmap/client-side

.firebase/hosting.YnVpbGQ.cache

@@ -0,0 +1,17 @@
+404.html,1705174543934,762bf484ba67404bd1a3b181546ea28d60dfddf18e9dd4795d8d25bcf3c1a890
+favicon.ico,1705164758605,27edce7be5922cf0bef7d4136f69b5bfbdd5bf8c13c7b026f71187d41a00aa7d
+logo192.png,1705164758606,79e2b749561016bc8af300ea19f48347ceed3cb1a54f48ae456172eca45e08f0
+logo512.png,1705164758607,212b102aa09e51b3b3e06647e81f7801a61333e171f6582e8124379aabccb41d
+manifest.json,1705164758608,ee04fb47e525c67d8424ffe9b4d8a8a24e434504478afca4e0ca602146836d4c
+robots.txt,1705164758609,bfe106a3fb878dc83461c86818bf74fc1bdc7f28538ba613cd3e775516ce8b49
+asset-manifest.json,1705177242329,9a0e33bf23968c815f9c6ef95ff29eda34e3d0fc85a69ddb43b8cf5d62561944
+index.html,1705177242328,7ad10da0ec25df620657b11797cbf35a96adf4ed5a52935fb3c87583303ea9fc
+static/css/main.f2e09b25.css,1705177242420,6a7377e6b21ba8c31991b11735119b9a7792b812bcb4b15dc574bbbd4984bb84
+static/css/main.f2e09b25.css.map,1705177242421,14d34018e7debe991f46de4fca5f6253dd434c39443e9254e25b5e5af84f8d75
+static/js/787.02f037f9.chunk.js,1705177242421,76fa99f0d2322a59d1f03be7afcf203d1c2846e07dcd7130055a03f8134ea863
+static/js/787.02f037f9.chunk.js.map,1705177242424,4895f71c1084ab7e88a0c4a61a0b1a79c1db3c97807d33ca14699ec318fd8ca4
+static/js/main.185a1fc9.js.LICENSE.txt,1705177242421,963c34d2e87f55eb8993727802418c31449a9493369df8a8f048617cdf6a2a28
+static/media/public.fafa67c655ced9a33e21.png,1705177242421,5a28ab84fadf70c2574d1fcdd8a4b4707f615a101cb72bf0222200818d3c162f
+static/media/cover-image.0d2b4cb81de09e34d255.jpeg,1705177242421,9f67c37a773b9b9ef5d683969347fc809ed45947518d5a511d79d0ace106ca52
+static/js/main.185a1fc9.js,1705177242427,7306a6c7e2b7668ecf64fb639d96e2001032fb86c563957d337472603bf9d9a4
+static/js/main.185a1fc9.js.map,1705177242428,c4cb594e364bc23f5ced25e461239a398e9f5697f7fac0994bcaee0efbe4f7b5

.firebase/hosting.cHVibGlj.cache

@@ -0,0 +1,7 @@
+404.html,1705174543934,762bf484ba67404bd1a3b181546ea28d60dfddf18e9dd4795d8d25bcf3c1a890
+index.html,1705174544593,8256f16ae205197ba3e568302316c9b05ee5222a69840214931a830c118af12c
+manifest.json,1705164758608,ee04fb47e525c67d8424ffe9b4d8a8a24e434504478afca4e0ca602146836d4c
+logo192.png,1705164758606,79e2b749561016bc8af300ea19f48347ceed3cb1a54f48ae456172eca45e08f0
+favicon.ico,1705164758605,27edce7be5922cf0bef7d4136f69b5bfbdd5bf8c13c7b026f71187d41a00aa7d
+robots.txt,1705164758609,bfe106a3fb878dc83461c86818bf74fc1bdc7f28538ba613cd3e775516ce8b49
+logo512.png,1705164758607,212b102aa09e51b3b3e06647e81f7801a61333e171f6582e8124379aabccb41d

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "roadmap-wpi"
+  }
+}

.github/workflows/firebase-hosting-merge.yml

@@ -0,0 +1,20 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+'on':
+  push:
+    branches:
+      - main
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm ci && npm run build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_ROADMAP_WPI }}'
+          channelId: live
+          projectId: roadmap-wpi

.github/workflows/firebase-hosting-pull-request.yml

@@ -0,0 +1,17 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on PR
+'on': pull_request
+jobs:
+  build_and_preview:
+    if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm ci && npm run build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_ROADMAP_WPI }}'
+          projectId: roadmap-wpi

README.md

@@ -1,70 +1,76 @@
-# Getting Started with Create React App
+<p align="center">
+  <a href="https://github.com/WPI-Roadmap">
+    <img src="Roadmap.png" alt="Roadmap-WPI" width=200 height=200>
+  </a>
+  <h3 align="center">Roadmap-WPI</h3>
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+  <p align="center">
+    A universal solution to introduce you to WPI's major requirement system <br> Developed by WPI students for WPI students (GoatHack 2024).
+    <br>
+    </p>
+</p>
 
-## Available Scripts
+### About
 
-In the project directory, you can run:
+Roadmap-WPI provides a clean, aesthetic visual solution to help incoming WPI students understand the major requirements system. The website is designed to be easy to use and understand, and is a great resource for students to use when planning their academic career by keeping track of their major requirements and progress as well as visualizing prerequisites and course offerings. This project was developed by Randy Huang, Tarun Eswar, Ajay Bhagavatula, Erica Dong, and Charles Tang for the GoatHacks 2024 hackathon at WPI.
 
-### `npm start`
+### Technical
+#### Technology Used
+<div align="center">
+<p align="center"> <a href="https://expressjs.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/express/express-original-wordmark.svg" alt="express" width="40" height="40"/> </a><a href="https://getbootstrap.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/bootstrap/bootstrap-plain-wordmark.svg" alt="bootstrap" width="40" height="40"/> </a> <a href="https://www.w3schools.com/css/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-original-wordmark.svg" alt="css3" width="40" height="40"/> </a>  <a href="https://firebase.google.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/firebase/firebase-icon.svg" alt="firebase" width="40" height="40"/> </a> <a href="https://www.w3.org/html/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/html5/html5-original-wordmark.svg" alt="html5" width="40" height="40"/> </a>  <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg" alt="javascript" width="40" height="40"/> </a> <a href="https://www.mongodb.com/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/mongodb/mongodb-original-wordmark.svg" alt="mongodb" width="40" height="40"/> </a> <a href="https://nodejs.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original-wordmark.svg" alt="nodejs" width="40" height="40"/> </a> <a href="https://reactjs.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="react" width="40" height="40"/> </a> </p>
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+</div>
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+#### Local Hosting
 
-### `npm test`
+To run the project locally, you may clone this respository. You must have Node version 18+ installed on your machine.
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+```bash
+git clone https://github.com/WPI-Roadmap/client-side.git
+```
 
-### `npm run build`
+Then, install the dependencies.
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+```bash
+cd client-side
+npm install
+```
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+Finally, run the project.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+```bash
+npm start
+```
 
-### `npm run eject`
+Go to `localhost:3000` to view the project.
 
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+### Feature List
 
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+- [x] Roadmap visualization for all majors (hierarchal diagram)
+- [x] Sync with OSCAR.wpi.edu and COURSELISTINGS.wpi.edu for up-to-date course offerings and professor/course ratings
+- [x] Tracking sheet digitization for helping you satisfy major requirements
+- [ ] LLM-based course recommendations based on your major, interests, and satisfaction with past courses
+- [ ] Profile syncing and WPI SSO
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+### Contributing
 
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+We'd love to have your help in making Roadmap-WPI better. The project still has work to do before full production launch, but if there's an issue you'd like to see addressed sooner rather than later, let us know. 
 
-## Learn More
+For any concerns, please open an [issue](https://github.com/WPI-Roadmap/client-side/issues), or feel free to, [fork the project and send a pull request](https://github.com/WPI-Roadmap/client-side/pulls). 
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+<hr>
 
-To learn React, check out the [React documentation](https://reactjs.org/).
 
-### Code Splitting
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+### Versions
+* Version 1.0 (01/14/2024)
+    * Initial Release
+    * See [Commits history]
 
-### Analyzing the Bundle Size
+### License
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
 
-### Making a Progressive Web App
+[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source-200x33.png?v=103)](#)  
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
 
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=for-the-badge)](https://github.com/tamzi/ReadMe-MasterTemplates/blob/master/LICENSE)

firebase.json

@@ -0,0 +1,10 @@
+{
+  "hosting": {
+    "public": "build",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  }
+}