🧠 Project Overview
Шаблон Project Template — это продакшен-готовый каркас для быстрого старта TypeScript-проектов.
Он экономит время при запуске нового репозитория и задаёт строгую структуру для кода, тестов, релизов и документации.
⚙️ Основная идея
Сделать старт нового проекта таким же быстрым и предсказуемым, как git clone.
Шаблон помогает:
- Ускорить старт разработки
- Обеспечить качество кода
- Масштабировать проект без хаоса
🧩 Компоненты шаблона
| Компонент | За что отвечает |
|---|---|
| TypeScript | строгая типизация |
| ESLint + Prettier | единый стиль |
| Vitest | тесты |
| Husky + lint-staged | защита коммитов |
| Standard Version | авто-релизы |
| Docusaurus | документация |
| GitHub Actions | CI/CD |
🏗 Архитектура проекта
- src/ — исходный код
- tests/ — юнит-тесты
- .github/workflows/ — CI/CD сценарии
- docs/ — документация
- package.json — все скрипты проекта
🚀 Цели проекта
- Создать единый стандарт качества
- Автоматизировать релизы и деплой
- Сделать документацию частью пайплайна
- Поддержать масштабируемую архитектуру
🧭 Roadmap
| Этап | Статус | Описание |
|---|---|---|
| ✅ Инициализация | done | структура и скрипты |
| ✅ Документация | done | Docusaurus + GitHub Pages |
| 🔄 API Reference | in progress | оформляем публичные интерфейсы |
| 🔜 CLI Tools | next | добавить CLI-модули |
| 🔜 Monorepo | next | поддержка workspaces |
| 🔜 Docker Dev Setup | next | контейнеризация окружения |
💡 Философия
- Простота > магия — всё понятно и прозрачно
- Автоматизация > ручные действия — CI/CD делает всю рутину
- Стандарты > хаос — одинаковый код во всех проектах