cassiusfive / mink Goto Github PK

Mink is a student-oriented class scheduling tool designed to streamline the course registration process. You provide the classes you plan to take along with your preferences, and Mink finds the schedules that best fit your needs. Currently serving Oregon State University’s course catalog.

See it live here!

• npm
• postgres

Create a Postgres DB and load course data to it using:

pg_restore -U username -d dbname < db.tar

Navigate to the server directory and install dependencies:

cd server && npm install

Create a .env in the server directory following this format:

# Express
PORT="3000"
HOST="127.0.0.1"

# Postgresql
DATABASE_URI="postgresql://username:[email protected]:port/dbname"

Now navigate to the client directory and install dependencies:

cd ../client && npm install

Create another .env pointing to the backend:

VITE_API_ENDPOINT="http://127.0.0.1/v1"

To use the project run npm run dev in the server and client directories.

Then type “o” into the shell running Vite to open the site running locally in your browser.

• Export CRNs
• View detailed course info
• Favorite schedules
• Scheduling Algorithm Overhaul
  • Fitness Function redefinition
  • Meta-heuristic local search
• Mobile responsiveness

Any contributions to the project are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. Don’t forget to give the project a star!

1. Fork the project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m ‘Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.

If you have any questions about the project or just wanna chat, feel free to reach out to me!

Cassius V - [email protected]

*psssstt* If you're an OSU student, let's do some hackathons