Template

A simple TypeScript template with modern development tools.

Features

• ⚡ Vite - Fast build tool and dev server
• 📦 TypeScript - Type safety
• 🎨 Tailwind CSS - Utility-first CSS framework
• ✅ Vitest - Fast unit testing
• 🔧 ESLint - Code linting
• 🎯 Prettier - Code formatting
• 🐺 Husky - Git hooks
• 📝 Conventional Commits - Commit message format

Getting Started

Prerequisites

• Node.js (version 18 or higher)

Installation

1. Clone the repository:

   git clone <your-repo-url>
   cd template

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open your browser and navigate to http://localhost:5173

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run test - Run tests
• npm run lint - Check code quality
• npm run lint:fix - Fix linting issues
• npm run agent-check - Run build, lint, and test (full check)

Project Structure

template/
├── src/
│   ├── main.ts          # Entry point
│   ├── index.css        # Global styles (Tailwind)
│   └── vite-env.d.ts    # Vite type definitions
├── tests/
│   ├── main.test.ts     # Basic tests
│   └── setup.ts         # Test setup
├── public/              # Static assets
├── package.json         # Dependencies and scripts
├── vite.config.ts       # Vite configuration
├── vitest.config.ts     # Test configuration
├── tsconfig.json        # TypeScript configuration
├── eslint.config.js     # ESLint configuration
├── tailwind.config.js   # Tailwind configuration
└── README.md           # This file

Extending the Template

This template provides a solid foundation for TypeScript projects with modern tooling. To extend it:

1. Add your source files to the src/ directory
2. Create components, utilities, or modules as needed
3. Write tests in the tests/ directory
4. Update dependencies in package.json as required
5. Customize configurations to match your project needs

License

This project is licensed under the MIT License - see the LICENSE file for details.