Contributing to the project

Thank you for your interest in contributing into the project! While the codebase is currently maintained by a single person

Preflight Checklist

• Read and understand the project's code of conduct
• Agree to the Developer's Certificate of Origin (We don't do CLAs here to minimize legal admin headaches with the HCB team.)
• For Hack Clubbers, join the #leeksbot-meta (app dev and project meta discusions) and the main #hackclub-leeks channel.

Setting up Development Environment

In general, we use the latest Node.js LTS (currently 22.x at the time of writing) for the runtime and documentation site (via npm) and Postgres for data presistence.

With Nix

WARNING

You need to be inside a devenv shell for Prisma Client to work properly on NixOS.

We use devenv via Nix flakes using the direnv integration. If you do use VS Code, install its integration after installing direnv via your NixOS/home-manager configuration or nix-env -iA nixpkgs.direnv / nix profile install nixpkgs#direnv (if you have flakes experimental feature enabled).

You may be prompted to run direnv allow once in order to initialize the dev environment.

Secrets

Secrets are managed via dotenvx, with Doppler for safely storing the private keys. If you want to run the dev instance yourself, ask @ajhalili2006 for the value of DOTENV_PRIVATE_KEY in Hack Club Slack (or via email at [email protected]).