NextNodeTemplate/docs/QUICK_START.md
2025-11-02 16:47:30 +03:00

95 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Быстрый старт с улучшениями
## 🚀 Установка всех зависимостей
```powershell
# Frontend
cd frontend
npm install
# Backend
cd ../backend
npm install
```
## ⚙️ Настройка переменных окружения
```powershell
# Frontend
cd frontend
Copy-Item .env.example .env.local
# Отредактируйте .env.local при необходимости
# Backend
cd ../backend
Copy-Item .env.example .env
# Отредактируйте .env при необходимости
```
## 🏃 Запуск в разработке
### Обычный способ (без Docker):
```powershell
# Терминал 1 - Backend
cd backend
node server.js
# Терминал 2 - Frontend
cd frontend
npm run dev
```
### С Docker:
```powershell
docker-compose up -d
```
## 📝 Форматирование кода
```powershell
cd frontend
npm run format # Форматировать весь код
npm run format:check # Проверить форматирование
```
## 🧪 Проверка работы
1. **Backend**: Откройте http://localhost:3001/api/health
2. **Frontend**: Откройте http://localhost:3000
3. **Пример API**: Попробуйте POST на http://localhost:3001/api/example/data
### Тестовый запрос:
```powershell
# PowerShell
Invoke-RestMethod -Uri "http://localhost:3001/api/example/data" -Method POST -ContentType "application/json" -Body '{"name":"Test","value":123}'
```
## 📊 Просмотр логов
Backend логи находятся в `backend/logs/`:
- `error.log` - ошибки
- `combined.log` - все логи
В консоли также выводятся логи (в режиме разработки).
## ✅ Чеклист перед деплоем
- [ ] Все зависимости установлены
- [ ] `.env` файлы настроены
- [ ] Линтер проходит без ошибок (`npm run lint`)
- [ ] Форматирование проверено (`npm run format:check`)
- [ ] Production build собирается (`npm run build`)
- [ ] Логи работают корректно
- [ ] Rate limiting настроен (если нужно)
- [ ] Валидация работает на всех endpoints
## 🔍 Дополнительная информация
- Подробное руководство: [`docs/USAGE_GUIDE.md`](USAGE_GUIDE.md)
- Правила проекта: [`docs/PROJECT_RULES.md`](PROJECT_RULES.md)
- База знаний: [`docs/KNOWLEDGE_BASE.md`](KNOWLEDGE_BASE.md)