search

ComputerScienceHouse / schedulemaker

A course database lookup tool and schedule building web application for use at Rochester Institute of Technology.
http://schedule.csh.rit.edu
GNU General Public License v2.0
62 stars 36 forks source link

Project Setup/Documentation? #56

Open willshen opened 10 years ago

willshen commented 10 years ago

Hi there, I came across this project while looking to build something similar for my group to allow students to generate schedule and such. I would love to be able to use what you have done, but I am not too sure how this project is set up. Is there documentations somewhere?

bgrawi commented 10 years ago

Hello,

Unfortunately, there is no official documentation for setting up/running ScheduleMaker on other systems at the moment. The Computer Science House is debating releasing a version of ScheduleMaker specifically designed to be redistributed for use on other campuses or projects which would obviously come with documentation.

You can however still try to set the project up in its current state.

The current system is very tied in to getting a specially formatted dump file from RIT's SIS system, so if you were to create your own project, you would have to either contact RIT's ITS department and negotiate the dump format, or write a new data adapter that can fill the schema appropriately. If you are not using RIT's data at all (for another college, I don't know what you had in mind), then of course you will have to write a data adapter or scraper regardless. Be warned that the current schema is very RIT-oriented, meaning it was originally designed for quarters, not semesters, so there is some legacy structure in there.

Once you've gotten the data into your database, the process for setting up the front end is easy:

  1. Fire up a LAMP stack or equivalent server and add a virtual host to the project's root
  2. Install NodeJS and NPM if you don't already have them
  3. Run npm install and then npm run-script build to build the site
  4. Success!

Regardless if you decide to fork our project or not, feel free to look at our source code for ideas/inspiration to help your project out.

soduko commented 7 years ago

https://github.com/soduko/schedulemaker/wiki

I've only begun to learn web development but this project is something I'd like to adapt for my university or atleast for myself.

I've created a fork with a wiki which I'll use to document what I've figured out to help new comers like myself in the future. If you get a chance, look over it and let me know where my misunderstandings are. You can contribute aswell!