The online platform for GreatUniHack 2021, allowing participants to sign up to the hackathon, create or join a team, view sponsors & challenges, and submit their projects.

These instructions will get the hackathon platform up and running on your local machine.

You need node and npm installed globally on your machine. You will also need to make a Firebase account.

Cloning the repository:

git clone https://github.com/greatunihack/2021-greatunihack-bot.git
cd 2021-greatunihack-bot

Environment variables:

Duplicate the .env.example file to create a .env file.

Windows

copy .env.example .env

MacOS/Linux

cp .env.example .env

Replace the placeholder values with the credentials for your Discord bot.

Installation:

npm install

Starting the project:

npm start

Generating API documentation:

npm run docs

This will generate a docs directory. You should open index.html from this directory to access the documentation.

• Sam Hirst

This project is licensed under the MIT License - see the LICENSE file for more details.