Skip to content

Latest commit

 

History

History
144 lines (92 loc) · 6.84 KB

README.md

File metadata and controls

144 lines (92 loc) · 6.84 KB
Raw

HackathonManager

Build Status Code Climate Test Coverage security

🚨 Read me!

HackathonManager v3.0.0 is under heavy development. It is recommended you wait until that is released before using this application.

HackathonManager will also be following the gitflow workflow with all commits going to the develop branch. When v3.0.0 is ready it will be available as a release along with a dedicated v3.0.0 branch.

❤️ HackathonManager Contributors

An all-in-one platform for managing hackathon registration & logistics, originally developed for BrickHack.

Read more at coderit.org/hackathon-manager/

  • Hacker applications: Enable hackers to apply to your hackathon while providing all relevant information (contact info, school, demographics, etc)
  • MyMLH support: Streamline the application process when users log in with MyMLH, a common platform for applying to any MLH hackathon. Basic info is pre-filled based on a common application, so hackers don't have to re-type it every time.
  • Admissions & RSVPs: Facilitate accepting hackers to your hackathon & enable them to RSVP
  • Bus Lists: Coordinate bus sign-ups during the RSVP process while communicating important information to riders & captains
  • Email communication: Ensure hackers get consistent, timely information throughout their application process, while enabling your organizing team to communicate important information at any time.
  • Statistics & Visualization: Surface key analytics about your admissions, distribution of applicants, progress towards attendance, etc.

Usage

HackathonManager is a standalone web app separate from your regular marketing website/public homepage.

A typical setup would be:

  • brickhack.io — Marketing site with event info, schedule, sponsors, etc and a button to apply
  • apply.brickhack.io — HackathonManager deployment to accept hacker applications + host management dashboard

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:

Get Started

Deploy HackathonManager for your hackathon »

Deploy

Documentation

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 website/.

Doc & website changes are auto-built and deployed via Travis CI once merged into master.

Commits + Releases

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.

Contributing

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.

Local Development

  1. Setup Ruby + MySQL for local development

If you don't already have Ruby + MySQL set up, see this guide by GoRails for pointers.

  • Select your computer's operating system & version
  • If given the choice, use rbenv -- this will ensure a clean, sustainable Ruby dev environment
  • SQLite and PostgreSQL steps are optional
  1. Clone the repo
$ git clone [email protected]:codeRIT/hackathon-manager
$ cd hackathon-manager
  1. Install dependencies
$ bundle install
  1. Setup databse
$ bin/rails db:setup
  1. Start up the server
$ bin/rails s  # short for bin/rails server

  1. Visit http://localhost:3000/apply, create an account, and complete an application

  2. In another bash window, promote your user to a director

$ 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, :director)
  1. Visit http://localhost:3000/manage and set up the hackathon as needed

See https://coderit.org/hackathon-manager/ for docs on regular hackathon setup

Local Development Utilities

  • Mail View - Email templates can be previewed at http://localhost:3000/rails/mailers
  • Mail Catcher - When active, emails will be captured by MailCatcher instead of slipping into a black hole (no emails are ever sent in development). Visit mailcatcher.me and follow instructions under "How" to get setup.
  • Guard - Automatically runs tests based on the files you edit. bundle exec guard
  • Coverage - Test coverage can be manually generated via the bin/rails coverage:run command. Results are then made available in the coverage/ directory.
  • Sidekiq - Run background jobs (such as emails) and view active & completed jobs. Sidekiq is automatically started with Docker - a dashboard is available at http://localhost:3000/sidekiq (also available in production).

License

The gem is available as open source under the terms of the MIT License.