docs

Nuxt 3 Starter Kit - Документация

Добро пожаловать в документацию Nuxt 3 Starter Kit! Этот набор предоставляет готовую архитектуру для быстрого создания современных веб-приложений с использованием Nuxt 3, Vue 3, TypeScript, PrimeVue и Tailwind CSS.

🚀 Быстрый старт

Требования

• Node.js 18+
• npm или yarn

Установка

# Клонирование репозитория
git clone https://github.com/odilovicc/starter-kit
cd starter-kit

# Установка зависимостей
npm install

# Запуск в режиме разработки
npm run dev

Доступные команды

npm run dev      # Запуск сервера разработки
npm run build    # Сборка для продакшена
npm run preview  # Предварительный просмотр сборки

📚 Содержание документации

• Архитектура проекта - Обзор структуры и принципов организации
• Компоненты UI - Документация по UI компонентам
• Формы - Работа с формами и валидацией
• Аутентификация - Система аутентификации и авторизации
• API и composables - Работа с API и composables
• Стилизация - Цветовая палитра и стили
• Типизация - TypeScript типы и интерфейсы
• Примеры использования - Практические примеры

🎨 Цветовая палитра

Наш стартовый набор использует единую цветовую палитру:

• Primary: #6237A0 - Основной цвет бренда
• Info: #3B82F6 - Информационные элементы
• Success: #10B981 - Успешные операции
• Warning: #F59E0B - Предупреждения
• Danger: #EF4444 - Ошибки и опасные действия

🛠 Технологический стек

• Nuxt 3 - Vue.js фреймворк для универсальных приложений
• Vue 3 - Прогрессивный JavaScript фреймворк
• TypeScript - Типизированный JavaScript
• PrimeVue 4 - UI компонентная библиотека
• Tailwind CSS - Utility-first CSS фреймворк
• Pinia - State management для Vue
• Firebase - Backend-as-a-Service

📁 Структура проекта

starter-kit/
├── app/                    # Конфигурация приложения
├── assets/                 # Статические ресурсы
│   ├── css/               # Глобальные стили
│   └── scss/              # SCSS компоненты
├── components/            # Vue компоненты
│   ├── client/            # Клиентские компоненты
│   ├── form/              # Компоненты форм
│   └── ui/                # UI компоненты
├── composable/            # Composable функции
├── layouts/               # Макеты страниц
├── pages/                 # Страницы приложения
├── stores/                # Pinia stores
├── types/                 # TypeScript типы
└── utils/                 # Утилиты

🎯 Основные возможности

• ✅ Готовая система аутентификации с Firebase
• ✅ Типизированные формы с валидацией
• ✅ UI компоненты на основе PrimeVue
• ✅ Responsive дизайн с Tailwind CSS
• ✅ TypeScript для типобезопасности
• ✅ State management с Pinia
• ✅ API composables для работы с бэкендом
• ✅ Готовая структура для масштабирования

🤝 Поддержка

Если у вас есть вопросы или предложения по улучшению документации, создайте issue в репозитории проекта.

---

Версия: 1.0.0
Последнее обновление: Декабрь 2024