honey-pot

Internal (and slightly external) dashboard to for Hackathons @ Berkeley and our events.

Setup

Install pnpm

Follow the instructions on pnpm.io, or install using cURL

curl -fsSL https://get.pnpm.io/install.sh | sh -

Clone honey-pot's Dev Branch & Dependencies

git clone git@github.com:calhacks/honey-pot.git -b dev
cd honey-pot
pnpm install

Environment Variables

pnpx vercel link
# ? Set up “~/Personal/calhacks/honey-pot”? (Y/n)
Y
# ? Which scope should contain your project? (Use arrow keys)
❯ Hackathons at Berkeley
# ? Found project “hackathons-at-berkeley/honey-pot”. Link to it? (Y/n)
Y
pnpx vercel env pull .env.development.local

Supabase

pnpx supabase login
pnpm gen:supabase # generate database schemas to local types

Development

pnpm dev

Tooling

Linter

honey-pot uses oxlint for linting (pnpm lint, pnpm lint:fix). Your development experience will heavily benefit from Oxidation Compiler's tooling. Oxc's tooling support is found here.

Formatting

honey-pot uses Biome for formatting (pnpm fmt, pnpm fmt:fix). Your development experience will heavily benefit from Biome's tooling. Biome's tooling support is found here.

We will (probably) migrate to Oxc Formatter once stable!

Contributing

Make sure to follow all the steps in development.