Giter Club home page Giter Club logo

mlh-hackathon-boilerplate's Introduction

MLH/mlh-hackathon-boilerplate

This is a hackathon boilerplate created by Major League Hacking. Using Jekyll, it has a extensible configuration that covers basic event information. You can then fork the website and have it hosted free through GitHub Pages. It's free to use.

Advantages:

  • Built in support for MyMLH
  • Community-owned and maintained
  • Free hosting through GitHub Pages
  • Discoverable through Google Search, Twitter and Facebook

Getting Started

  1. Create a GitHub account if you haven't already.
  2. Fork this repository to your own account. Click here to fork this repo.
  3. Edit _config.yml to configure for your own hackathon website.
  4. That's it - you should be able to access at https://[github username].github.io/mlh-hackathon-boilerplate/

Setting up a custom domain

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 [email protected] to obtain your free coupon code.

  1. Register your domain.
  2. Update the domain www to CNAME [github username].github.io
  3. Update the domain @ to A 192.30.252.153 and A 192.30.252.154
  4. Update the CNAME in your GitHub fork of mlh-hackathon-boilerplate to your new domain (i.e. examplehacks.com)

Reference: GitHub - Setting up an apex domain

Setting up SSL

We'd highly recommend looking into Cloudflare for SSL with your domain. It's compatible with GitHub Pages and this project.

Contributing

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:

  • We can't accept custom plugins because it's not supported by GitHub Pages.
  • If adding any external images or components, please ensure you have the correct permission to use them.
  • We advise creating a GitHub issue first explaining the issue.

mlh-hackathon-boilerplate's People

Contributors

bih avatar sprusr avatar shy avatar theycallmeswift avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.