Developer Commands

Note

Link to Justfile can be found here

Shared

just dev - Will run both the backend and frontend development server at the same time.

just devd - Will run both the backend and frontend development server at the same time, but the backend will be in debug mode. See just backend-dev-debug.

Database

just drop - Will drop your local database's public schema using the credentials provided in .env

just migrate - Will migrate your local database using the credentials provided in .env

just migrate-prod - Will manually migrate production database using the credentials provided in .env.production

Warning

Should be used sparingly

just copy-stg - Will pull credentials from infra/.env.production and do the following:

1. Drop all tables from staging db
2. Copy all data from production db to staging db
3. Scrub/sanitize all records/tables that should not be allowed in staging db.

Warning

Should be used sparingly

Frontend

just dev - Will run both the backend and frontend development server at the same time.

just frontend-install - Download any missing frontend dependencies. An alias for cd js && pnpm i.

just frontend-dev - Will only start the frontend Vite dev server.

just types-gen - Regenerate the schema.ts file.

Warning

The backend must be running

just frontend-test - Run the entire frontend test suite - linters, autoformatters, typechecking, etc

Backend

just backend-install - Builds and installs Spring backend. An alias for ./mvnw install -DskipTests=true.

just backend-dev - Will only start the backend Spring dev server.

just backend-dev-debug - Will only start the backend Spring dev server, but will wait for a JVM debugger to attach to port 5005 first.

just backend-test - Run Checkstyle and then the full test suite.

just backend-coverage - Runs just backend-test and opens up the JaCoCo test coverage page in your default browser.

just backend-spotless - Runs the backend formatter (currently Spotless with Palantir Java Formatter) and indicates whether or not you need to run the formatter on any files.

just backend-spotless-fix - Runs the backend formatter (currently Spotless with Palantir Java Formatter) and will write to any files that have not been formatted yet.

React Email

just email-dev - Run the React Email dev server.

just email-gen - Will run email/email.sh which will build all React Email components into HTML and pass them into the backend's static folder.

Warning

This is mainly used in development.