Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (59 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

90 lines (59 loc) · 1.51 KB

Getting started

Install deps

  • Install pnpm
  • Install deps with pnpm i

Setup .env file in /demo:

You can copy /demo/.env-example to /demo/.env:

DATABASE_URL=postgresql://postgres:prisma@localhost:5432/stl_demo
NEXTAUTH_JWT_SECRET=(random string)
NEXTAUTH_SECRET=(random string)

Start the db

Via docker compose:

In /demo:

docker compose up -d

Via brew:

brew services start postgresql@14 # run the initdb manually if needed
brew services info postgresql@14 # expect loading to be true

in /demo/.env, set it like so:

DATABASE_URL=postgresql://$USER:prisma@localhost:5432/stl_demo

such that this works:

psql -U $USER -d postgres

Bootstrap prisma

In /demo:

pnpm prisma migrate dev

Start the main build watch process

(In monorepo root directory)

pnpm watch

TypeScript won't be able to resolve packages' references to each other before their build output is in packages/*/dist. The build:watch command runs tsc -b --watch on the packages, so that changes in one are quickly available in another.

Start the demo app

In /demo:

pnpm dev

Run tests

(In monorepo root directory)

pnpm test

Release

To create a release:

  1. Merge the feature PR into main. The commit message should follow conventional commits.
  2. Wait for release-please to run, which should result in a PR being opened. Merge that PR.
  3. git checkout main && git pull main
  4. pnpm publish-git