Comet Planning is a tool for planning out students' college experience
Comet Planning allows students to plan out including coursework, co-curricular activities like studying abroad and research, and extracurricular involvement in student organizations. It does this with an intuitive drag-and-drop interface that represents various college activities as blocks and displays them in semester groups.
Planning coursework poses a challenge for many.
From choosing the right professors to knowing when to take a class, schedule planning is the bane of any college student.
UTD students have access to tools like UTD Grades and Rate My Professors to help them pick classes for a specific semeester, but there hasn't been a solution that allows a student to say, "I want to major in CS, minor in psychology, and do a few internships before grad school. Generate a plan lets me do all of that with the professors I want."
Until now, that is.
Comet Planning is an integrated solution designed to help students plan out their entire undergraduate experience in one place. It allows students to focus on ensuring their college experience holistically suits their desires and optimize for long-term success.
- Drag-and-drop interface for planning coursework by semester for any degree plan
- Sign in to save data across planning sessions
- Export to file to share your custom plan with someone else
This project requires a working Node.js and NPM installation.
To start, clone the repository, and then run npm start to launch a local development server
at localhost:3000 by default.
git clone https://github.com/acmutd/comet-planning
cd comet-planning
git checkout dev
npm startTo set up Firebase, go to the Firebase console and download the credientials. Paste the
body of the config into src/firebase.config.js in the exported block.
For example, src/firebase-config.js should look something like this:
export default {
// Config goes here
apiKey: 'some_api_key',
authDomain: 'cometplanning.firebaseapp.com',
databaseURL: 'https://cometplanning.firebaseio.com',
projectId: 'cometplanning',
storageBucket: 'cometplanning.appspot.com',
messagingSenderId: 'some_messaging_sender_id',
appId: 'some_app_id',
};Note: Changes to src/firebase-config.js should not be checked into source
control. To prevent accidents, the project .gitignore automatically ignores
changes to the file.
This project loosely uses the Git Flow branching model.
There are three types of branches: master, which always contains complete, production-ready copies of project code, dev, which is guaranteed to at least be runnable on any machine (generally free of bugs), and feature branches, which are children of dev that are primarily used to create new features.
Here is the process to make changes to the project:
- From
dev, create a new feature branch. For example,auth-signin - Make commits to the feature branch.
- When enough of the feature is complete, open a pull request to merge changes from your feature branch to
dev. For larger features or changes to code, open a draft pull request to track changes until completion. - Request a review from a project contributor, and add the pull request to a project board and milestone (if applicable)
- When a review is complete, a contributor will squash merge the feature branch into
dev. The feature branch can then be deleted.
Current:
Past:
Sometimes you may have questions regarding the development of this product. If the answer was not found in this readme please feel free to reach out to the development officers at [email protected].
We request that you be as detailed as possible in your questions, doubts or concerns to ensure that we can be of maximum assistance. Thank you!
