Commit 6065aa47 authored by Cool Fire's avatar Cool Fire

Add readme.

parent 4d76bfe6
Pipeline #323 passed with stages
in 1 minute and 28 seconds
# Shell signup site
This website is made to allow users to sign up to the Insomnia 24/7 shell service.
## Requirements
### Ruby
We're developing using Ruby 2.4.1 but it should work with most any modern Ruby version. Get it either from your package manager, brew, rbenv, or any other means you perfer.
### Bundler gem
This is used to install any dependencies required. `gem install bundler` should be all you need to do once your ruby environment is set up.
### Sinatra
We use the Sinatra web framework for pretty much all of this site. Sinatra and all dependencies should be installed by running `bundle install`.
## Running a local development copy
This should be as simple as running `rackup` and going to `http://localhost:9292`.
## Contributing
If you have any changes you would like to make or any bugfixes you want to submit you can fork this project, make your changes, and create a merge request through the gitlab interface. Before creating a merge request make sure all syntax, linting, and tests pass. Do not try to commit to your own master branch as gitlab CI will try and fail to deploy it, causing your builds to fail. Always commit to your own development/feature/fix branch and create your merge request from there.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment