Easy Starter Vite React SPA

A lightweight, maintainable Vite + React foundation for API-driven SPAs, dashboards, internal tools, and embedded applications.

فارسی · Documentation · Report an issue

“What do we build for, if not to lessen each other’s hardship?”

Important

This repository is currently in the foundation stage. Do not treat it as production-ready until the first stable release.

What it solves

Avoids turning a small client-side application into an oversized full-stack project while preserving structure, testability, and production build quality.

Use this template for

• API-driven single-page applications
• Internal dashboards and admin tools
• Embedded widgets and interactive tools
• Static-hosted applications without a server runtime

Not intended for: SEO-critical public websites, server-rendered applications, or secret-bearing backend logic.

Baseline

• Vite, React, and TypeScript
• Feature-oriented project boundaries
• Routing, forms, API client, and error-state conventions
• Environment validation without exposing secrets
• Tests, linting, CI, and static deployment profiles

Detailed architecture, conventions, deployment profiles, and extension guides belong in docs/. Feature work starts from specs/, and agent rules live in AGENTS.md.

Quick start

1. Click Use this template or run:

   gh repo create my-project --template easy-starter/easy-starter-vite-react-spa --private --clone
   cd my-project

2. Set the project name, package metadata, and environment values.

3. Start the project:

   cp .env.example .env.local
   make setup
   make dev
   make check

4. Write the first feature specification under specs/.

5. Implement the feature and keep make check green.

Working agreement

• Read AGENTS.md and the relevant specification before changing code.
• Reuse existing patterns before adding abstractions or dependencies.
• Never commit credentials or production data.
• Run the repository quality checks before opening a pull request.
• Record architecture-changing decisions in docs/decisions/.

Documentation

Start with docs/getting-started.md. Broader AI-first development guidance is maintained in Easy Starter Docs.

Contributing and support

See CONTRIBUTING.md for contribution rules and SUPPORT.md for help. Security issues must follow SECURITY.md.

License

Released under the MIT License.