vchamberland / school-brainhack.github.io

Website of the BrainHack School

Brainhack School

This is the website of the brainhack school, built with hugo.

Deploying site

The deployment of the website is automated using github actions.

Run locally

To test it locally, you will need to:

1. Create your own fork

2. Clone this GitHub repo or the fork (change the URL if it's a fork):

   git clone https://github.com/school-brainhack/school-brainhack.github.io.git

3. Make sure you're inside the school-brainhack.github.io/ directory, then clone the submodule for themes:

   cd school-brainhack.github.io
   git submodule update --init --recursive --remote

4. If Hugo is not installed, follow the steps in their documentation to install it on your machine: https://gohugo.io/getting-started/installing/

5. To run the website locally, make sure you are still in school-brainhack.github.io/ directory and build the website with

   hugo serve -D

   The -D option is to serve the website including the draft .md files.

   Navigate the local version to make sure things are compiled correctly.

Contributors