Skip to content

fix: make local dev environment work after a fresh clone #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andygrunwald wants to merge 6 commits into
base: next
Choose a base branch
from
+11 −6
Open

fix: make local dev environment work after a fresh clone #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c9b5060
fix(db): load apps/api/.env when running prisma migrate dev
andygrunwald May 24, 2026
e4dd25e
fix(api): pre-seed dummy AWS SES credentials in .env.example
andygrunwald May 24, 2026
72ef3f1
docs: clarify local dev setup steps in CONTRIBUTING.md
andygrunwald May 24, 2026
2c39b19
docs: drop stale root .env copy step from CONTRIBUTING.md
andygrunwald May 24, 2026
fb2b691
Revert "fix(db): load apps/api/.env when running prisma migrate dev"
andygrunwald May 24, 2026
b758007
docs: Fix local development setup guide, by providing the right DATAB…
andygrunwald May 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,21 @@ For local development without Docker:

```bash
# Clone and install
git clone <repo-url>
cd app
git clone git@github.com:useplunk/plunk.git
cd plunk
yarn install

# Start infrastructure services (PostgreSQL, Redis, MinIO)
yarn services:up

# Set up environment variables
cp .env.example .env
# Edit .env with your configuration
cp apps/api/.env.example apps/api/.env
cp packages/db/.env.example packages/db/.env

# Edit apps/api/.env with your configuration
# Important! To start the api-server, the two variables `AWS_SES_ACCESS_KEY_ID` and `AWS_SES_SECRET_ACCESS_KEY` must not be empty.
# Dummy values are pre-set to enable local development (without the ability to send emails).
# If you plan to send emails in your development environment, replace the dummy values in `apps/api/.env`.

# Run database migrations
yarn workspace @plunk/db migrate:dev
Expand Down
4 changes: 2 additions & 2 deletions apps/api/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ S3_FORCE_PATH_STYLE=true
# AWS SES (Required - for sending emails)
# ==============================================================================
AWS_SES_REGION=eu-north-1
AWS_SES_ACCESS_KEY_ID=
AWS_SES_SECRET_ACCESS_KEY=
AWS_SES_ACCESS_KEY_ID=foo
AWS_SES_SECRET_ACCESS_KEY=bar

# Configuration sets for email tracking
SES_CONFIGURATION_SET=plunk-configuration-set # Default: with open/click tracking
Expand Down
Loading