# AGENTS.md

🌼 🌼 🌼 🌼 🌼  The most popular, free and open-source Tailwind CSS component library

## Setup

```
npm install
```

## Commands

```
npm run dev          # run locally
npm run build        # produce a build
npm run test         # run the test suite, must pass before any commit
npm run lint         # lint
npm run format       # format
npm run check        # lint and type check
npm run build:dev
npm run build:docs
```

## Layout

- `packages/` 303 source files

## Conventions

- Tests live alongside the code they cover, following `packages/daisyui/functions/addPrefix.test.js`.
- CI defines what passing means. See `.github/workflows/deploy-docs.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/bundle/daisyui.js` is 341KB. It will not fit comfortably in context, so read it in parts.
- 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.