An all-in-one platform for managing hackathon registration & logistics, originally developed for BrickHack.
Read more at coderit.org/hackathon-manager/
HackathonManager is a standalone web app separate from your regular marketing website/public homepage.
A typical setup would be:
This allows your public marketing site to operate however you want it (e.g. GitHub pages) while HackathonManager lives in an isolated, consistent environment.
HackathonManager makes use of a few different third-party services & Ruby gems:
Documentation is available at https://coderit.org/hackathon-manager/
Docs are maintained as markdown files in the
docs/ folder, with the website configuration & tooling stored in
Doc & website changes are auto-built and deployed via Travis CI once merged into master.
Releases are automatically generated by semantic-release using commit messages.
Commit messages should follow the standard
type(scope): subject format. For example:
feat: Improve form typography
deploy(heroku): Ensure db:migrate is run after each deploy
fix: Support HTTPS in questionnaire portfolio URL
For more information, see semantic-release's how does it work.
GitHub issues and pull requests welcome!
All documentation is easily editable using the GitHub UI. Click the "Edit" button at the top of any documentation page to get started.
If there's a new feature you're looking to implement, please file an issue to open discussion on the feature before starting work or opening a pull request.
If you don't already have Ruby + MySQL set up, see this guide by GoRails for pointers.
rbenv-- this will ensure a clean, sustainable Ruby dev environment
$ git clone email@example.com:codeRIT/hackathon-manager $ cd hackathon-manager
$ bundle install
$ bin/rails db:setup
$ bin/rails s # short for bin/rails server
Visit http://localhost:3000/apply, create an account, and complete an application
In another bash window, promote your user to an admin
$ cd hackathon-manager $ bin/rails c # short for bin/rails console # Wait for the console to start... Loading development environment (Rails 5.1.1) irb(main):001:0> User.last.update_attribute(:role, :admin)
See https://coderit.org/hackathon-manager/ for docs on regular hackathon setup
bundle exec guard
bin/rails coverage:runcommand. Results are then made available in the
The gem is available as open source under the terms of the MIT License.