Files
liqa/CLAUDE.md
T
Andrii Arsenin 6bc1b6fb19 chore: make .env optional and comment out all example settings
- load .env in compose only when it exists; every setting has a default
- comment out every setting in .env.example, with ## for descriptions
  and # VAR=default for settings to uncomment
- update README, development docs and CLAUDE.md accordingly
2026-09-30 21:23:18 +03:00

4.3 KiB

liqa

liqa is a browser automation and QA service for web applications. It stores scenarios (ordered Playwright steps), snippets (reusable code run via context.runSnippet), environments, credentials and sessions, and runs scenarios in headless Chromium. Scenarios and snippets are versioned; each run records the scenario version it executed.

It is an npm workspace with two packages:

  • server/ - NestJS API + scheduler + MCP server, SQLite via TypeORM (synchronize: true, so entity changes alter the schema on startup - there are no migrations). REST API under /api/v1, Swagger UI at /docs, MCP at /mcp, health at /health.
  • client/ - React 19 + Vite SPA (i18n strings in client/src/i18n/locales/en.json).

Docs

Default deployment (docker compose)

compose.yaml at the repo root runs a single liqa container, built from the root Dockerfile, at http://localhost:13000. The server serves everything: the UI at / (the built client, via CLIENT_DIR), the REST API at /api/v1, MCP at /mcp, Swagger at /docs. It reads .env if present (optional - every setting has a default) and mounts ./data (SQLite DB data/liqa.db + stored files).

Rebuild and restart: docker compose up -d --build. Check with docker compose ps, curl localhost:13000/health and docker compose logs liqa.

The live database is data/liqa.db. Because the schema is synced on startup, back it up before deploying entity changes.

Code quality

Before committing, run and pass all of these (and report the results):

# server
cd server && npm run lint && npx tsc --noEmit -p tsconfig.json && npm test && npm run build
# client
cd client && npm run lint && npm run build
  • Lint must stay clean in both packages (no errors, no warnings).
  • Don't run prettier over whole existing files; several aren't prettier-clean and it produces unrelated diffs. Format only new files or the lines you changed.
  • Server tests use an in-memory DB, a Playwright mock (server/test/__mocks__/playwright.ts), and a temporary files directory per test app (see server/test/app.harness.ts).
  • Import Node.js built-in modules with the node: prefix (node:fs, node:path, node:crypto, ...).

Committing a new version

When asked to commit:

  1. Ask which version to bump - major, minor or patch - and propose a sensible default based on the changes: patch for fixes and small behavior/default tweaks, minor for new features, major for breaking changes (e.g. changed API or export/import formats that old clients or files can't use).
  2. Run the code quality checks above.
  3. Bump version in the root package.json and in both places at the top of package-lock.json (the root entry and packages[""]). server/package.json and client/package.json keep their own versions; don't bump them.
  4. Add a ## <version> - <YYYY-MM-DD> entry at the top of CHANGELOG.md ("Changes since :", then ### Added / ### Changed / ### Fixed). Mark breaking changes with Breaking:.
  5. Update the docs affected by the change (docs/*.md, README.md, .env.example, MCP tool descriptions).
  6. Build the commit message with the /git-commit skill if it is available, following its format and rules. Otherwise use a conventional commit message (type(scope): subject, then a bullet list body). Either way, put the version bump in the body as a bullet (e.g. - bump version to <version>), not in the subject line. This overrides the skill's rule of putting versions in the subject. Then make the commit with that message.
  7. After committing, ask the user whether to rebuild and restart the docker compose containers (docker compose up -d --build); don't do it without confirmation.