DeerHacks

DeerHacks Hackathon 2024 Dashboard

Open Source & Attribution

This project is an open source archive of the DeerHacks 2024 Website & Dashboard and is licensed under the GPL v3.0 License. We also ask that you keep the footer attribution to the original creators if you decide to use this project for any derivative works.

Setup

1. Run yarn install to install dependencies
2. Install all the required workspace @recommended extensions
3. Add the required .env files from discord #configs / mcss drive

Getting Started

First, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Going Full Stack

The DeerHacks dashboard leverages the DeerHacks Backend and DeerHacks CMS to provide a full stack experience. To get started, follow the instructions in the respective repositories.

Ensure that the ports and environments are configured to work with each other.

Testing

Run the commands to catch any linting / type errors:

yarn lint
yarn check-types

These commands are run before pushing with husky and in our CI/CD pipeline with GitHub Actions.