# {{projectName}}

{{description}}

[![npm version](https://img.shields.io/npm/v/{{projectName}}.svg)](https://www.npmjs.com/package/{{projectName}})
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![CI](https://github.com/{{githubUsername}}/{{projectName}}/actions/workflows/ci.yml/badge.svg)](https://github.com/{{githubUsername}}/{{projectName}}/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/{{githubUsername}}/{{projectName}}/badge.svg?branch=main)](https://coveralls.io/github/{{githubUsername}}/{{projectName}}?branch=main)

## Development Workflow

This project is built using **Vite 8** for high-performance development and bundling.

### Available Scripts

- `pnpm run dev`: Starts the development server.
- `pnpm run build`: Builds the project for production.
- `pnpm run preview`: Previews the production build.
- `pnpm run test`: Runs the unit test suite (browser-based for web targets using **Vitest** and **Playwright**).
- `pnpm run integration-test`: Runs integration tests using **Playwright**.
- `pnpm run lint`: Lints and formats the codebase using **oxlint** and **oxfmt**.
- `pnpm run ci`: Full CI pipeline (lint, build, test).

## Getting Started

1. **Install dependencies**:
   ```bash
   pnpm install
   ```
2. **Start development server**:
   ```bash
   pnpm run dev
   ```
3. **Run tests**:
   ```bash
   pnpm run test
   pnpm run integration-test
   ```

## Tooling

- **Vite 8**: Modern, ultra-fast development and build tool.
- **Vitest**: Vite-native testing framework with browser support.
- **Playwright**: Reliable E2E and browser automation.
- **oxlint**: Extremely fast JavaScript/TypeScript linter. Default rules live in `oxc.config.ts` (managed); customize overrides in `oxlint.config.ts`.
- **oxfmt**: High performance JavaScript / TypeScript formatter. Default settings live in `oxc.config.ts` (managed); customize overrides in `oxfmt.config.ts`.
- **Husky & Commitlint**: Ensuring high-quality commit messages.
- **Conventional Changelog**: Automated changelog generation with the Angular preset.