https://github.com/utmmcss/2025.deerhacks.ca

https://github.com/utmmcss/2025.deerhacks.ca

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/utmmcss/2025.deerhacks.ca
• Owner: utmmcss
• License: gpl-3.0
• Created: 2024-11-10T18:35:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-01T18:49:58.000Z (6 months ago)
• Last Synced: 2026-01-04T07:50:10.802Z (5 months ago)
• Language: TypeScript
• Size: 38.5 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# DeerHacks

[![DeerHacks Image](public/backgrounds/collage_close.jpg)](https://2024.deerhacks.ca)

> DeerHacks Hackathon 2024 Dashboard

[![Build Status](https://api.netlify.com/api/v1/badges/e85686f6-63b4-4028-94f2-c27d34c488d7/deploy-status)](https://app.netlify.com/sites/deerhacks/deploys)

[![Website Status](https://img.shields.io/website?down_color=red&down_message=offline&up_color=green&up_message=online&url=https%3A%2F%2F2024.deerhacks.ca)](https://deerhacks.ca)

## 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](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 `npm 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:

```bash

npm run dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Going Full Stack

The DeerHacks dashboard leverages the [DeerHacks Backend](https://github.com/utmmcss/deerhacks-backend) and [DeerHacks CMS](https://github.com/utmmcss/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:

```bash

npm run lint

npm run check-types

```

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