Nest Starter Kit
Этот Showcase заменяют, когда из пакета nest-starter-kit делают Product.
Открыть /docsЗачем Nest Starter Kit?
Время уходит на Product, а не на первую неделю настройки API.
Проверенное окружение
Приложение стартует только при корректном окружении.
Без аккаунта вендора
Вход и почта работают без аккаунта у вендора.
Описанные контроллеры
Каждый контроллер описан на /docs.
Меньше подготовки. Больше Product.
Nest Starter Kit снимает работу по API, которую иначе пришлось бы повторять в каждом Product.
| Возможность | Без Nest Starter Kit | С Nest Starter Kit |
|---|---|---|
| Идея | − | − |
| Проверенное окружение | − | + |
| Пользователи и вход | − | + |
| Почта без аккаунта вендора | − | + |
| Хранение аватара | − | + |
| Проверки здоровья | − | + |
| Swagger | − | + |
Что остаётся покупателю
Это части API, которые Product оставляет. Это не вторая таблица.
- User
- auth
- health
- storage
- Swagger
Как запустить
Из каталога Kit, по порядку.
- Скопируйте файл окружения и задайте адрес базы и оба секрета JWT.
.env.example - Установите пакет nest-starter-kit.
pnpm install - Запустите PostgreSQL.
pnpm db:up - Примените миграции.
pnpm db:migrate - Создайте одного member и одного admin.
pnpm db:seed - Запустите API.
pnpm dev - Откройте документацию контроллеров.
/docs
Читать и пробовать API
Visitor Users и их аватары на этом Showcase тогда удаляются.