# {{PROJECT_NAME}}

> {{PROJECT_DESCRIPTION}}
---
## 🚀 Quick Start

### Prerequisites

- Node.js {{NODE_VERSION}} or higher
- {{PACKAGE_MANAGER}} (npm/yarn/pnpm)

### Installation

```bash
# Clone the repository
git clone <repository-url>
cd {{PROJECT_NAME}}

# Install dependencies
{{PACKAGE_MANAGER}} install

# Start development server
{{PACKAGE_MANAGER}} run dev
```

### Environment Setup

Copy `.env.example` to `.env` and configure:

```bash
cp .env.example .env
```

See `specs/configuration.md` for all environment variables.
---
## 📁 Project Structure

```
{{FOLDER_STRUCTURE}}
```
---
## 🛠️ Development

### Available Scripts

- `{{PACKAGE_MANAGER}} run dev` - Start development server
- `{{PACKAGE_MANAGER}} run build` - Build for production
- `{{PACKAGE_MANAGER}} run preview` - Preview production build
- `{{PACKAGE_MANAGER}} run test` - Run tests
- `{{PACKAGE_MANAGER}} run lint` - Run linter
- `{{PACKAGE_MANAGER}} run format` - Format code

### Tech Stack

- **Framework:** {{UI_FRAMEWORK}} {{UI_FRAMEWORK_VERSION}}
- **Build Tool:** {{BUILD_TOOL}}
- **Styling:** {{STYLING_APPROACH}}
- **State Management:** {{STATE_MANAGEMENT}}
- **Testing:** {{UNIT_TEST_FRAMEWORK}}, {{E2E_FRAMEWORK}}

See `ai-instructions.md` for complete tech stack.
---
## 📚 Documentation

**For AI Assistants:**
- `AGENT.md` - Start here for AI context
- `ai-instructions.md` - Tech stack and rules

**For Developers:**
- `docs/components.md` - Component architecture
- `docs/state-management.md` - State patterns
- `docs/styling.md` - Styling guidelines
- `docs/testing.md` - Testing strategy
- `specs/accessibility.md` - A11y requirements
---
## 🧪 Testing

```bash
# Run all tests
{{PACKAGE_MANAGER}} run test

# Run with coverage
{{PACKAGE_MANAGER}} run test:coverage

# Run E2E tests
{{PACKAGE_MANAGER}} run test:e2e
```
---
## 🚢 Deployment

{{DEPLOYMENT_INSTRUCTIONS}}

See `docs/operations.md` for detailed deployment procedures.
---
## 🤝 Contributing

See `docs/contributing.md` for contribution guidelines.
---
## 📄 License

{{LICENSE}}
---
**Last Updated:** {{GENERATION_DATE}}


