Parallel Documentation

Appearance

Dashboard Service - Infrastructure ​

Infrastructure setup ​

Databases ​

Uses Prisma with PostgreSQL.

Schema Location: services/dashboard/prisma/schema.prisma

bash
docker compose -f 'docker-compose.yml' up -d --build 'databases'

to stop:

bash
docker compose -f 'docker-compose.yml' down 'databases'

Prisma Commands ​

bash
nx run dashboard:prisma:generate # generate types
nx run dashboard:prisma:reset # reset the database depending on the variable DATABASE_URL

Performing a Migration ​

  1. Modify the schema.prisma file of the service you're working with
  2. Trigger the nx command migrate:dev:create, which will automatically generate the migration file within the /migrations folder. Check the result as this command can be dangerous to merge/roll back
  3. Run the migration with the nx command migrate:dev
  4. Generate the schemas with the nx command prisma:generate.
  5. Obviously test your changes

You can then create your PR.

For deployment to the environments, you'll notice in the Dockerfile that a script entrypoint.sh is triggered. This script will automatically deploy your migration, meaning your migration will automatically be applied across the environments once the service starts.

Valkey (queues & event system) ​

bash
docker compose -f 'docker-compose.yml' up -d --build 'valkey'

to stop:

bash
docker compose -f 'docker-compose.yml' down 'valkey'

Local Development Setup ​

Running the Service ​

Install Dependencies ​

bash
pnpm install

Environment variables ​

  1. Add a .env.dev at the service root
  2. Get the environment variables from 1password for the corresponding service

Commands ​

bash
# Development
nx run dashboard:dev

# Build
nx run dashboard:build

# Test
nx run dashboard:test

# Lint
nx run dashboard:lint

# Run in Docker
docker compose -f 'docker-compose.yml' up -d --build 'dashboard'

# Check dependencies
nx show project dashboard

# Show affected projects (based on git changes)
nx affected:graph

Shared Packages ​

The shared packages (dto, models, utils) are automatically linked and can be imported in both backend and frontend applications. Any changes to these packages will trigger rebuilds in dependent applications.

These packages mostly contain global functions (like logger, utils, ...) shared among services, providing common functionality and ensuring consistency across the monorepo.

Available Packages ​

  • dto - Data Transfer Objects
  • models - Shared data models
  • utils - Utility functions and helpers