/mlh-no-light

No Light - one of the many fun mini-events we run.

Primary LanguageRubyMIT LicenseMIT

This is a micro service that allows participants of the No Light mini-event to quickly submit their entries (see below for more info). The organizer of the mini-event can then conveniently download a ZIP file of all the entries.

CircleCI

FAQ

What is No Light?

No Light is a mini-event that Major League Hacking organizes at our hackathons in North America & Europe. Using a really basic code editor, students have 15-20 minutes to replicate a webpage with no previews along the way.

How do I setup my own version of No Light?

Firstly, you will want to fork the repository. You can deploy this on a service like Heroku with the following configuration: Ruby 1.9.3 and a MongoDB instance.

A few don'ts:

  • Please do not use the Outage font.
  • Please do not use the Major League Hacking logo, name or trademarks.
Setup No Light (on Mac OS X):
$ git clone https://github.com/bih/no-light.git
$ cd no-light
$ bundle install

Setup MongoDB (on Mac OS X):
$ brew install mongodb
$ cd no-light
$ mkdir data && mkdir data/db
$ mongod --dbpath data/db

Set ENV variable (on Mac OS X):
$ export MY_MLH_KEY=...
$ export MY_MLH_SECRET=...

Launch server locally (on Mac OS X):
$ rackup

How do I use No Light?

The best way to run through this is through a little story. Here goes.

This story has three characters: Jon, Jane and Sam. Jon is the person moderating No Light. Jane and Sam are both participants.

Jon tells Jane and Sam to go to http://no-light.mlh.io/whatever-this-event-is-called and it just works. Jon did no setup beforehand. Jon also shows a website that Jane and Sam need to replicate in 20 minutes.

Jane and Smith visit the URL above and write their code. After 20 minutes, they both submit their code by pressing the big '!light' button. They loved the event though were nervous as to what their webpage looked like.

Jon's excited to show the submissions. He visits the link that was given to Jane and Sam and he added .zip to the end (so the link to download the zip is http://no-light.mlh.io/whatever-this-event-is-called.zip). He is now given a ZIP file of all the submissions. Amazing.

Jon opens each file and picks one winner through an audience vote.

End of story.

Screenshots

Contributing Guidelines

Use the following guides for getting things done, programming well, and programming in style.

LICENSE

The micro service for No Light is released under the MIT Licence. More information can be found in LICENSE.md.