https://github.com/yamandevelopment/schedulix

A program that helps university students develop their course schedules for their upcoming semester.
https://github.com/yamandevelopment/schedulix

backend frontend gui hackathon hacktoberfest hacktoberfest2023 javascript node nodejs scheduler svelte university

Last synced: 11 days ago
JSON representation

A program that helps university students develop their course schedules for their upcoming semester.

• Host: GitHub
• URL: https://github.com/yamandevelopment/schedulix
• Owner: YamanDevelopment
• License: mit
• Created: 2023-10-21T14:00:28.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-29T01:52:41.000Z (about 1 month ago)
• Last Synced: 2024-10-11T03:21:56.572Z (28 days ago)
• Topics: backend, frontend, gui, hackathon, hacktoberfest, hacktoberfest2023, javascript, node, nodejs, scheduler, svelte, university
• Language: JavaScript
• Homepage: https://schedulixfedemo.zachl.tech/
• Size: 492 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Schedulix

**Winner of the [NightHacks](https://nighthacks.devpost.com/) hackathon's top category: "Best Advanced Hack"**

**Submission: [Devpost](https://devpost.com/software/schedulix)**

## Table of Contents

- [Schedulix](#schedulix)

  - [Table of Contents](#table-of-contents)

  - [Description](#description)

  - [Inspiration](#inspiration)

  - [Algorithm](#algorithm)

  - [Usage](#usage)

  - [Contributing](#contributing)

  - [To-Do](#to-do)

  - [License](#license)

## Description

Schedulix is a program that helps university students develop their course schedules for their upcoming semester. It takes in the user's preferences and generates multiple schedules that fit the user's preferences. The program is written in JavaScript and uses the [Node.js](https://nodejs.org/en/) runtime environment. 

## Inspiration

Having to make our college schedule while being dually enrolled in high school is such a pain especially having to consider so many variables, so we thought why not be able to automate this all the while still keeping our meticulous preferences in our schedule and on top of that give us multiple options to choose from. Multiple choice schedules perfect for everyone!

## [Algorithm](src/backend/README.md)

## Usage

1. Clone the repository

2. Run `node main.js` in the terminal (uses hardcoded preferences)

3. Currently, the program hardcodes the preferences, but it will be updated to take user input in the future

## Contributing

If you want to help out with our code, contributions are welcomed! Feel free to fork the repository and make a pull request with your changes so we can review them :thumbsup:. If you have any questions, feel free to contact us.

## To-Do

- [ ] Add user input

- [ ] Add more preferences

- [ ] Create a scraper to get course data from the university's website

- [ ] Link the backend to the frontend

## License

Unless otherwise specified, everything in this repository is covered by the [MIT License](https://choosealicense.com/licenses/mit/).