Skip to content

RITHonorsTechCommittee/honors-d3-housing

Repository files navigation

honors-d3-housing

Honors housing selection UI created with d3.js

To Run

honors-d3-housing comes with a Ruby script server.rb to make it easy to run the housing app on your computer. If you have ruby installed, run ruby server.rb from the command line. The server will then be available at http://localhost:8088. The server can be stopped by pressing Ctrl-C (or Cmd-. on Mac).

How to install Ruby

Contributing Code

To make changes to honors-d3-housing, first clone the repository then create a new branch for whatever you are working on. It is recommended to make your branch name include your username and what you are working on. Do not make changes to the main branch! When you have made your changes, commit them and push your branch to this repository. Finally, submit a pull request for your branch to be merged into master. Your changes can then be reviewed by everyone else and integrated into master.

Step by Step

For those unfamiliar with git, here are the commands that you would issue:

(First time only) git clone https://github.com/RITHonorsTechCommittee/honors-d3-housing

  1. Get to the master branch git checkout master.
  2. Create a new branch based on master git checkout -b <my-new-branch-name>.
  3. Edit the files in your favorite editor
  4. Commit your changes git add ., git commit -m "Change description"
  5. Push your branch to GitHub git push origin <my-new-branch-name>.
  6. Submit pull request using GitHub's web interface
  7. Wait for feedback :)