Commands

This document provides a comprehensive overview of the available project commands for building, developing, setting up, cleaning, formatting, Docker integration, Prisma, and management tasks.

Build

All

Builds all packages and applications in the project.

npm run build

Internal Packages

Builds all internal packages, including:

• types
• prisma
• utils

npm run build:packages

Individual Packages

Builds the types package.

npm run build:types

Builds the prisma package.

npm run build:prisma

Builds the utils package.

npm run build:utils

Individual Applications

Builds the Storybook documentation.

npm run build:storybook

Builds the backend API.

npm run build:api

Builds the frontend application.

npm run build:app

Development

Start Development Servers

Starts dev servers for the API and the frontend app.

npm run dev

Starts dev servers for all projects: API, app, Storybook, etc.

npm run dev:all

Start Individual Dev Servers

Runs Storybook in development mode.

npm run dev:storybook

Starts the backend API in dev mode.

npm run dev:api

Starts the frontend application in dev mode.

npm run dev:app

UI

Adds new UI components from the app.

npm run ui:add

Setup

Runs all setup tasks, including DB and CDN setup.

npm run setup

Database Setup

Initializes and sets up the database.

npm run setup:db

CDN Setup

Sets up the CDN services required by the project.

npm run setup:cdn

Environment Setup

Creates and configures environment variable files (.env).

npm run setup:env

Seed Database

Seeds the database with sample data.

npm run setup:data

Generates sample transactions and inserts them into the database.

npm run setup:generate-transactions

Clean

Removes all node_modules and build artifacts.

npm run clean

Clean Specific Artifacts

Removes .next, dist, .turbo, and storybook-static.

npm run clean:build

Cleans the TurboRepo cache only.

npm run clean:turbo

Removes all .env files.

npm run clean:env

Cleans the database of all seeded sample data.

npm run clean:data

Formatting & Linting

Formats all code files (TypeScript, Markdown, TSX) using Prettier.

Make sure code is formatted and linted before committing.

npm run format

Runs lint checks using TurboRepo.

npm run lint

Docker

Network Setup

Creates a Docker network if it doesn't already exist.

npm run docker:create-network

Start Individual Dev Containers

Starts the database container.

npm run docker-dev:db

Starts the API container.

npm run docker-dev:api

Starts the frontend app container.

npm run docker-dev:app

Opens Prisma Studio inside a Docker container.

npm run docker-dev:studio

Starts the CDN container.

npm run docker-dev:cdn

Start All Containers

Starts all development containers.

npm run docker-dev

Starts all production containers.

It runs a script that download the latest Docker images and starts the containers.

npm run docker

Prisma

Generates the Prisma client based on schema.

npm run prisma:generate

Applies Prisma database migrations.

npm run prisma:migrate

Opens Prisma Studio to inspect and edit the database.

npm run prisma:studio

Management

Publishes Storybook to Chromatic.

npm run chromatic