Руководства
Практические руководства для разработчиков, работающих с Integ API.
Для кого эти руководства
- Новые разработчики - начните с Первоначальной настройки
- Ежедневная работа - используйте Ежедневный workflow
- Решение проблем - смотрите Частые ошибки
Доступные руководства
Начало работы
| Руководство | Описание | Когда использовать |
|---|---|---|
| Первоначальная настройка | Полная настройка окружения | Один раз при старте |
| Установка | Установка зависимостей | Первый запуск |
| Конфигурация | Настройка environment | Первый запуск |
Ежедневная работа
| Руководство | Описание | Когда использовать |
|---|---|---|
| Ежедневный workflow | Типичный день разработчика | Каждый день |
| Git workflow | Работа с git | При коммитах |
| Правила кода | Стандарты написания | При написании кода |
Решение проблем
| Руководство | Описание | Когда использовать |
|---|---|---|
| Частые ошибки | Типичные проблемы | При ошибках |
| Troubleshooting | Общие решения | При проблемах |
Быстрые ссылки
Команды на каждый день
bash
# Утро - запуск проекта
npm run docker:up && npm start
# Перед коммитом
npm run lint:fix && npm run typecheck
# Миграции
npm run migration:runПолезные URL
| Сервис | URL | Назначение |
|---|---|---|
| API | http://localhost:3000/api | REST API |
| Swagger | http://localhost:3000/api/reference | Документация API |
| Документация | http://localhost:5177 | VitePress docs |
| Health | http://localhost:3000/health | Проверка состояния |
Выбор руководства
mermaid
graph TD
Start[Начало] --> Q1{Первый раз?}
Q1 -->|Да| FirstSetup[Первоначальная настройка]
Q1 -->|Нет| Q2{Проблема?}
Q2 -->|Да| CommonErrors[Частые ошибки]
Q2 -->|Нет| DailyWorkflow[Ежедневный workflow]Связанные документы
- Архитектура - понимание системы
- API Guide - работа с API
- Deployment - деплой приложения