This is a boilerplate template for any hackathon to use. It has a configuration that covers everything you'll want to make your hackathon website accessible, discoverable & ready for registration with our single sign on solution MyMLH. It was first announced at Hackcon EU 2016 in Eindhoven, The Netherlands.
Click here to view a demo.
- (30 Aug 2016) Initial release of version 0.1.0
- Create a GitHub account if you haven't already.
- Fork this repository to your own account. Click here to do so.
- Edit
_config.ymlto configure for your own hackathon website. - That's it - you should be able to access at
https://[github username].github.io/mlh-hackathon-boilerplate/
Want to configure for your own custom domain? Great! Through our excellent partners Domain.com, Major League Hacking is offering free domains to student hackathon organizers. Reach out to hi@mlh.io to obtain your free coupon code.
- Register your domain.
- Update the domain
wwwtoCNAME [github username].github.io - Update the domain
@toA 192.30.252.153andA 192.30.252.154 - Update the
CNAMEin your GitHub fork ofmlh-hackathon-boilerplateto your new domain (i.e.examplehacks.com)
Reference: GitHub - Setting up an apex domain
We'd highly recommend looking into Cloudflare for SSL with your domain. It's compatible with GitHub Pages and this project.
Our boilerplate is written entirely in Jekyll, which GitHub automatically compiles. This dramatically reduces the technical barrier needed to setup a hackathon website. We'd love to receive your contributions towards making this even better. A couple of things to note:
- GitHub's variant of Jekyll doesn't allow custom plugins. We can't accept Jekyll plugins for this reason.
- Please ensure you have the correct permissions inside all of your PRs.
- Before creating a PR, it would be better if you created a GitHub Issue explaining the contribution. This isn't required, but advised.