https://github.com/hackmcgill/mchacks8

McHacks 8 static website
https://github.com/hackmcgill/mchacks8

Last synced: 3 months ago
JSON representation

McHacks 8 static website

• Host: GitHub
• URL: https://github.com/hackmcgill/mchacks8
• Owner: hackmcgill
• License: mit
• Created: 2020-11-21T19:33:01.000Z (about 5 years ago)
• Default Branch: dev
• Last Pushed: 2021-11-26T02:25:54.000Z (about 4 years ago)
• Last Synced: 2025-06-14T13:03:03.832Z (7 months ago)
• Language: JavaScript
• Homepage: mchacks8.hackmcgill.vercel.app
• Size: 32.2 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# [McHacks 8](https://2021.mchacks.ca)

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

## Setup

1. Make sure you have [node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/lang/en/) 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](https://github.com/hackmcgill/mchacks7/blob/develop/docs/CONTRIBUTING.md).

## 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.

[![Deploy to Vercel](https://vercel.com/button)](/import/project?template=https://github.com/hackmcgill/mchacks7)

### 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`.