packmind

# Nx Monorepo Structure

This is an Nx monorepo containing applications and reusable packages.

## Core Technologies

- **Runtime**: Node.js (version specified in `.nvmrc`)
- **Language**: TypeScript
- **Database**: PostgreSQL with TypeORM for entity persistence
- **Cache**: Redis for caching
- **Background Jobs**: BullMQ for job queue management
- **Testing**: Jest with @swc/jest as test runner

## Directory Structure

- `apps/` - Deployable applications (API, frontend, CLI, e2e tests, docs)
- `packages/` - Reusable domain and infrastructure packages shared across apps
- `.github/workflows/` - CI/CD pipelines for build, test, quality checks, and deployment

## Local Development Environment

Local development uses Docker Compose to run all services (API, frontend, Redis, PostgreSQL).
Docker Compose automatically provisions PostgreSQL and Redis - no manual setup required.

## Working with Nx

The following commands apply for both NX apps and packages (use `./node_modules/.bin/nx show projects` to list actual apps and packages.)
- Test a project: `./node_modules/.bin/nx test <project-name>`
- Lint a project: `./node_modules/.bin/nx lint <project-name>`
- Build a project: `./node_modules/.bin/nx build <project-name>`
- Test affected projects: `pnpm run test:staged`
- Lint affected projects: `pnpm run lint:staged`

## Code Quality

- **Linting**: `./node_modules/.bin/nx lint <project-name>` runs ESLint, using the config file `eslint.config.mjs`.
- **Formatting**: Prettier is used for code formatting. You don't have to run it, it's set as a pre-commit hook.

## Commands

- When running commands, ensure you use the correct Node version (see .nvmrc at the project's root level)
- When renaming or moving a file that is commited to git, use `git mv` instead of `mv`
- ensure the env variable `PACKMIND_EDITION` is properly set to `oss`
- when asked to execute `packmind-cli`, use `node ./dist/apps/cli/main.cjs`
- Some default skills use version-routed directories (`packmind-versions/<version>/`) and ask you to run `packmind --version` to pick the right one. Since you already run the local build with `node ./dist/apps/cli/main.cjs`, you always have the latest — skip the `--version` check and use the **highest-numbered** `packmind-versions/` directory (currently `0.35.0` for both `packmind-onboard` and `packmind-update-playbook`). There is no `next/` directory.

## Git Workflow

- The project uses **trunk-based development** (all work on `main` branch)
- Do NOT create branches yourself - let developers decide on branching strategy
- Each sub-task should have its own commit (as per Task splitting section)

## Security

- **Secrets Detection**: GitGuardian runs in CI to detect leaked secrets
- **Secrets Retrieval**: Always use `Configuration.getConfig()` from `@packmind/node-utils` to access secrets in code
- **Secrets Storage**: Infisical or environment variables are used for secrets management - never hardcode secrets

## Task splitting

- For any task you perform, you MUST split it into multiple into sub-tasks which have a logical increment (eg: new endpoint, new component, new use case etc). When a task is done, run all the validation steps (lint, test, packmind etc) and ask me for validation of the work you did.
- Each sub task MUST have its own commit.
- Use the `./node_modules/.bin/nx lint` and `./node_modules/.bin/nx test` commands on the apps and packages you've edited