# AGENTS.md

🔥🔥🔥 Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev          # run locally
pnpm start        # run the app
pnpm build        # produce a build
pnpm check        # lint and type check
pnpm clean
pnpm fix
pnpm fix:format
pnpm fix:lint
```

## Layout

- `apps/`        2721 source files
- `packages/`    1133 source files
- `deployments/` 7 source files

## Conventions

- Tests live alongside the code they cover, following `apps/api/plane/db/management/commands/test_email.py`.
- CI defines what passing means. See `.github/workflows/build-branch.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Copy `.env.example` before running anything that needs configuration.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.