# AGENTS.md

A modern vue admin panel built with Vue3, Shadcn UI, Vite, TypeScript, and Monorepo. It's fast!

## Setup

```
pnpm install
```

## Commands

```
pnpm dev             # run locally
pnpm build           # produce a build
pnpm lint            # lint
pnpm format          # format
pnpm check           # lint and type check
pnpm bootstrap
pnpm build:analyze
pnpm build:antd
```

## Layout

- `packages/`   770 source files
- `apps/`       302 source files
- `playground/` 195 source files
- `docs/`       78 source files
- `internal/`   76 source files
- `scripts/`    15 source files

## Conventions

- Tests live alongside the code they cover, following `internal/node-utils/src/__tests__/hash.test.ts`.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/effects/layouts/src/authentication/icons/slogan.vue` is 162KB. It will not fit comfortably in context, so read it in parts.

---

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.