a-sharapov / express-boilerplate

Lightweight TypeScript based backend boilerplate

Express Boilerplate

This is a boilerplate for Express.js projects, includes a basic setup for a REST API with GraphQL.

🚀 Запуск

Требования

Для успешного запуска проекта необходимо наличие cli-инструментов:

• Docker
• Docker Compose

или установленного:

• Docker Desktop

Использование

1. Склонировать репозиторий
2. Перейти в папку проекта
3. Разместить дамп базы данных в папке ./Docker/db/ под именем dump.sql (ЕСЛИ НЕОБХОДИМО)
4. Создать собственный .env файл на основе .env.example
5. Выполнить команду docker-compose up --build -d
6. Продолжить разработку

Все данные для работы будут отображены в терминале.

📝 Дополнительно

Возможна работа без использования GraphQL в режиме REST API.

Проект уже содержит демо миграции и сиды для базы данных.

npm run migrate
npm run seed

Также возможен запуск с локально установленной базой данных

(Но не желателен)

Режим разработки:

npm run server:watch

Режим сборки с последующим запуском:

npm run start