# AGENTS.md

:tada: A magical vue admin                                                                https://panjiachen.github.io/vue-element-admin

## Setup

```
npm install
```

## Commands

```
npm run dev           # run locally
npm run lint          # lint
npm run build:prod
npm run build:stage
npm run preview
npm run new
npm run svgo
npm run test:unit
```

## Layout

- `src/`            193 source files
- `mock/`           8 source files
- `tests/`          7 source files
- `plop-templates/` 4 source files
- `build/`          1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/unit/.eslintrc.js`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.