README.md

nztunnellers Project

Welcome! The below documentation aims to get you ready to contribute, introducing how to set up and run the project.

Happy contributing 🚀

What is the project about?

The New Zealand Tunnellers Web App is dedicated to a special military unit who fought in France during the First World War (1914-1918): the New Zealand Tunnelling Company.

This company was formed at a time where the British Army struggled in their fights against the German miners beneath the no man's land. The Web App tells the original story of this special unit and shares the men's war experience.

Before Starting

Make sure you have the following installed:

• Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew update

Source: Homebrew website

• pyenv

brew install pyenv
pyenv install 3.9.7

Source: pyenv GitHub repository

• MySQL

brew install mysql

Documentation Contents

• Getting Started
• Running Locally
• Contributing