McHacks 8

This repository contains the code behind the static site of McHacks 8.

Setup

1. Make sure you have node and yarn installed.
2. Run yarn global add gatsby-cli to install Gatsby CLI locally.
3. Run yarn to install dependencies.
4. Run gatsby develop to start dev server! 🚀

Scripts

Start the development server:

yarn start or gatsby develop

Build the website:

yarn build or gatsby build

Start the production server:

yarn serve or gatsby serve

Format code:

yarn format

Folder Structure

.
├── docs                    # Documentation files
├── public                  # Build and bundled files
├── src                     # Source files
│   ├── components          # Page sections files
│   ├── assets              # Assets files
│   │   ├── fonts
│   │   └── images
│   └── pages               # Page files
│   └── styles              # Style files
├── static                  # Unbundled assets

Contributing

Want to contribute to the McHacks site?

See our contributing guide.

Deployment

We are using Vercel to compile and host our code. When a PR is created, Vercel builds the site and generates a deploy preview to confirm everything is working as expected. Once code is merged to master branch, Vercel will promote the code to production at 2021.mchacks.ca. Vercel also handles the SSL certificate for this site.

Along with deploy previews, the develop branch is live at mchacks8.now.sh for an easier comparison to production.

Domains

The primary domain for this site mchacks.ca is registered with the HackMcGill Namecheap and DNS is with Cloudflare. The secondary domain mchacks.io is registered with Cloudflare. 2021.mchacks.ca and 2021.mchacks.io have CNAME records pointing to cname.vercel-dns.com.