Skip to content

cassiusfive/coursemink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About The Project

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!

Built With

React TypeScript Express.js Postgres Docker

Getting Started

First, download and install Docker.

Next, clone this repository using the following command:

git clone https://github.com/cassiusfive/coursemink.git

Then, use Docker Compose run the project:

docker-compose up -d

The application will be running locally, and you can access it at http://localhost:8080.

Roadmap

  • Automate all scraping
  • Ability to filter results
  • Support for blocking out times
  • Google Authentication
  • Support more colleges
  • Support multiple terms
  • Mobile support

Contributing

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

License

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

Contact

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

Cassius V - cassiusfive@gmail.com

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