# AGENTS.md

Create stunning demos for free. Open-source, no subscriptions, no watermarks, and free for commercial use. An alternative to Screen Studio.

## Setup

```
npm ci
```

## 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 lint:fix
npm run i18n:check
npm run preview
```

## Layout

- `src/`      173 source files
- `electron/` 42 source files
- `scripts/`  10 source files
- `tests/`    2 source files

## Conventions

- Tests live alongside the code they cover, following `docs/tests/writing-tests.md`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- 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

- 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.