Skip to content

uvmcscrew/hackhelp

Repository files navigation

HackHelp

HackHelp is a portal created to simplify team management, GitHub permission handling, & help ticketing for teams at the 2025 UVM Hackathon.

See more information on the repo wiki => https://github.com/uvmcscrew/hackhelp/wiki

Developers: Run it locally

Prerequisites

  • Bun
  • A PostgreSQL database
  • Github App Credentials

Dev Database with Docker

This project requires a vanilla (i.e. unmodified) PostgreSQL database. If you have Docker Compose (or the ability to use compose files with Podman/Orbstack/etc), you can use the compose file in this repo to spin up a development database for yourself.

The connection string with the credentials as set in the repo is postgres://cscrew:database@localhost:32700/hackhelp

Set up environment variables

Env Var Description
DATABASE_URL The url of your PostgreSQL database
GITHUB_APP_ID
GITHUB_APP_PRIVATE_KEY
GITHUB_APP_CLIENT_ID OAuth Client ID of the Github App
GITHUB_APP_CLIENT_SECRET OAuth Client Secret of the Github App
PUBLIC_GITHUB_ORGNAME The slug of the GitHub Org that HackHelp should control

Get Started

Install Dependencies

bun install

Run database migrations

bun db:migrate

Run the development server

bun dev

then visit http://localhost:5173

Development Notes

Code Line Counting

# Counting excluding installed ui components
# see .tokeignore
tokei
# Counting everything
tokei --no-ignore
Feb 26th 2025 at 21:32
===============================================================================
 Language            Files        Lines         Code     Comments       Blanks
===============================================================================
 CSS                     1           78           56            0           22
 HTML                    1           12           12            0            0
 JavaScript              2           53           43            6            4
 JSON                    3          130          130            0            0
 Markdown                1          109            0           67           42
 SVG                     1           11           10            1            0
 TypeScript             41         2300         1928           86          286
-------------------------------------------------------------------------------
 Svelte                 41         1268         1208            0           60
 |- JavaScript          36          648          547            5           96
 (Total)                           1916         1755            5          156
===============================================================================
 Total                  91         3961         3387          160          414
===============================================================================

Credits

License

This project is licensed under the MIT License

About

a tool to help manage permissions and help tickets at uvm's 2nd annual hackathon!

Resources

License

Stars

Watchers

Forks