Team6083 / cheesy-parts

Part management database written for the 2013 season.

Cheesy Parts

Cheesy Parts is a web-based system for tracking parts through the design and manufacture cycle. It assigns part numbers with which CAD files can be saved to version control and stores information about parts' current manufacturing status.

Cheesy Parts is written in Ruby using the Sinatra framework and uses MySQL as the backing datastore. Development and production are run on UNIX (OS X and Ubuntu), so there are no guarantees it'll work on Windows, sorry.

Development

Prerequisites:

• Ruby 1.9 (1.9.3-p286 is what we use in development and production)
• Bundler
• MySQL

To run Cheesy Parts locally:

1. Create an empty MySQL database and a user account with full permissions on it.
2. Populate config.json with the parameters for the development and production environments. Set enable_wordpress_auth to false and members_url to blank; they are used for a single sign-on (SSO) mechanism specific to Team 254.
3. Run bundle install. This will download and install the gems that Cheesy Parts depends on.
4. Run bundle exec rake db:migrate. This will run the database migrations to create the necessary tables in MySQL.
5. Run ruby parts_server_control.rb <command> to control the running of the Cheesy Parts server, where <command> can be one of start|stop|run|restart.

The database migration will create an admin account (username "[e-mail]", password "chezypofs") that you can use to first get into the system and create other accounts. It is highly recommended that you delete this account after having created your own admin account.

Deployment

Cheesy Parts deploys by checking out from Git on the production server. If you don't plan on making any changes, you can simply put a copy of the code on your server and edit the config in place. If you do plan on making periodic changes to the code, you can follow this procedure:

1. Fork cheesy-parts on Github, make your initial code/config changes, and commit them.
2. On the production server, clone your fork and start it up the first time.
3. Fill in your server-specific information in the deploy script.
4. Make any incremental changes in your development machine, test them locally, commit and push them, then run the deploy script.

The deploy script uses SSH to log into the production server, discard any local changes in the checked-out version of Cheesy Parts, pull from the origin, and restart the server.

Contributing

If you have a suggestion for a new feature, create an issue on GitHub or shoot an e-mail to [e-mail]. Or if you have some Ruby-fu and are feeling adventurous, fork this project and send a pull request.