diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 294af238e..34363869d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,16 +38,46 @@ branch are tagged into a release monthly. ``` cp .env.example .env && cp packages/database/.env.example packages/database/.env ``` - Open the root `.env` file and fill in the required values. -6. Start Docker. This starts the required services like Postgres. +5. Open the root `.env` file and fill in the required values for these services: + +
+ Resend + +

We use https://resend.com for email sending (including the magic-link signup/login system). They have a generous free tier of 100 emails a day that should be sufficient. Signup for Resend.com and enter the required environment vars below.

+ + ``` + RESEND_API_KEY= + FROM_EMAIL= + REPLY_TO_EMAIL= + ``` +
+ +
+ Magic Link + +

Both of these secrets should be random strings, which you can easily generate (and copy into your pasteboard) with the following command:

+ + ```sh + openssl rand -hex 16 | pbcopy + ``` + +

Then set them here:

+ + ``` + SESSION_SECRET= + MAGIC_LINK_SECRET= + ``` +
+ +7. Start Docker. This starts the required services like Postgres. ``` pnpm run docker ``` -7. Migrate the database +8. Migrate the database ``` pnpm run db:migrate ``` -8. Run the seed script +9. Run the seed script ``` pnpm run db:seed ```