express api es6 starter

Стартовое применение для строительства API с Express.js

Поставляется с:

• ES6 функции/модули
• Es7 async/ждать
• Книжная полка ORM и Knex Migrations
• Postgresql (по умолчанию) с поддержкой MySQL и SQLite
• Документация API с использованием Swagger-Ui-Dist и Swagger-jsdoc
• Поддержка Docker для разработки и производства
• Eslint для кодовой линии
• Проверка запроса с использованием JOI
• Форматирование кода с помощью красителя
• Управление конфигурацией с использованием dotenv
• Регистрация с помощью Уинстона
• Отчет об ошибках с использованием Sentry
• Тесты с использованием мокко, супертета и чая
• VS CODE встроенная поддержка отладчиков

---

Предварительные условия

• Node.js
• Пряжа
• Npm
• Postgresql / mysql / sqlite

Настраивать

Клонировать репозиторий, установить зависимости и сразу же начните.

 $ git clone --depth=1 [email protected]:mesaugat/express-api-es6-starter.git <application-name>
$ cd <application-name>
$ rm -rf .git
$ yarn   # or npm install

Сделайте копию .env.example как .env и обновите данные вашего приложения и учетные данные базы данных. Теперь запустите миграции и заседайте базу данных.

 $ yarn migrate
$ yarn seed

Наконец, запустите приложение.

 $ yarn start:dev (For development)
$ NODE_ENV=production yarn start (For production)

Перейдите к http: // localhost: 8848/api-docs/для проверки установки.

Создание новых миграций и семян

Это команды для создания новой миграции и соответствующего файла семян.

 $ yarn make:migration <name>
$ yarn make:seeder <name>

Пример,

 $ yarn make:migration create_tags_table
$ yarn make:seeder 02_insert_tags

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

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

Используйте Docker-Compose, чтобы быстро выпустить стек с предварительно сконфигурированным контейнером по базе данных Postgres. Данные являются эфемерными, и контейнеры исчезнут при удалении стека.

Конкретная конфигурация для Docker находится в .env.docker

• 0.0.0.0 как $APP_HOST чтобы разоблачить приложение на сетевом интерфейсе Docker
• Предварительно настроенные настройки Postgres - можно обновить, чтобы указать на другой хост Postgres

Принесите стек,

 $ docker-compose up

Перейдите к http: // localhost: 8848/api-docs/для проверки приложения работает от Docker.

Сбить стек,

 $ docker-compose down

MultiStage Docker сборка

Существует несколько целей сборки, доступных для разных этапов. Эти изображения могут использоваться для развертывания или запуска заданий в различных контейнерных облачной инфраструктуре, таких как Kubernetes, AWS ECS, FARGATE, Cloud Run GCP и т. Д.

1. Создание производственного изображения.

   $ docker build --target=prod -t express-api-es6-starter:prod .

2. Создание изображения для разработки.

   $ docker build --target=dev -t express-api-es6-starter:dev .

3. Создание изображения, которое запускает миграцию и/или откат.

    # Docker image that runs migration and seeds.
    $ docker build --target=migrate -t express-api-es6-starter:migrate .
   
    # Docker image that rollbacks migrations.
    $ docker build --target=migrate-rollback -t express-api-es6-starter:migrate-rollback .

Как только изображения были созданы - все, что вам нужно сделать, это запустить их, предоставляя файл .env . Так:

$ docker run -v " /path/to/your/.env:/app/.env " mesaugat/express-api-es6-starter:migrate

Использование MySQL вместо postgresql

Сначала установите драйвер MySQL.

 $ yarn add mysql

Обновите эти строки в вашем файле .env .

 - DB_CLIENT='pg'
+ DB_CLIENT='mysql'

- DB_PORT='5432'
+ DB_PORT='3306'

Вы можете удалить драйвер PG, если хотите.

 $ yarn remove pg

Вот и все, вы готовы катиться.

Тесты

Чтобы запустить тесты, необходимо создать отдельную тестовую базу данных. Не забудьте обновить свой файл .env , чтобы включить подключения для тестовой базы данных.

 $ NODE_ENV=test yarn migrate
$ yarn test

Запустите тесты с покрытием.

 $ yarn test:coverage

Почему 8848?

Потому что самая высокая точка в мире составляет 8848 метров.

Внося

Для вклада и запросов функций, пожалуйста, сначала создайте проблему.

Лицензия

Express-API-ES6-Starter находится под лицензией MIT.