express api es6 starter

Aplicación de inicio para API de construcción con Express.js

Viene con:

• Características/módulos de ES6
• ES7 async/espera
• Migraciones de estantería ORM y Knex
• PostgreSQL (predeterminado) con soporte para MySQL y SQLITE
• Documentación de API utilizando Swagger-Ui-Dist y Swagger-JSDOC
• Soporte de Docker para el desarrollo y la producción
• Eslint para el código de pelusa
• Validación de solicitud utilizando Joi
• Formato de código usando Prettier
• Gestión de configuración utilizando dotenv
• Registro usando Winston
• Información de errores usando Sentry
• Pruebas con moca, supertest y chai
• VS Código Soporte de depurador incorporado

---

Requisitos previos

• Nodo.js
• Hilo
• Npm
• Postgresql / mysql / sqlite

Configuración

Clonar el repositorio, instalar las dependencias y comenzar de inmediato.

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

Realice una copia de .env.example como .env y actualice los detalles de su aplicación y las credenciales de la base de datos. Ahora, ejecute las migraciones y sembra la base de datos.

 $ yarn migrate
$ yarn seed

Finalmente, inicie la aplicación.

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

Navegue a http: // localhost: 8848/api-docs/para verificar la instalación.

Creación de nuevas migraciones y semillas

Estos son los comandos para crear una nueva migración y un archivo de semillas correspondiente.

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

Ejemplo,

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

Usando Docker

Usando Docker-Compose

Use Docker-Compose para mencionar rápidamente una pila con contenedor de base de datos Postgres preconfigurado. Los datos son efímeros y los contenedores desaparecerán cuando se elimine la pila.

La configuración específica para Docker está en .env.docker

• 0.0.0.0 AS $APP_HOST para exponer la aplicación en la interfaz de red Docker
• Configuración de Postgres preconfigurada: se puede actualizar para apuntar a otro host de Postgres

Levanta la pila,

 $ docker-compose up

Navegue a http: // localhost: 8848/api-docs/para verificar que la aplicación se ejecute desde Docker.

Take Rown Stack,

 $ docker-compose down

Construcciones de Docker de varias etapas

Hay múltiples objetivos de compilación disponibles para diferentes etapas. Estas imágenes se pueden usar para implementar o ejecutar trabajos en una infraestructura en la nube basada en contenedores como Kubernetes, AWS ECS, Fargate, GCP Cloud Run, etc.

1. Construyendo una imagen de producción.

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

2. Construyendo una imagen para el desarrollo.

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

3. Construyendo una imagen que ejecuta la migración y/o la reversión.

    # 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 .

Una vez que se han construido las imágenes, todo lo que necesita hacer es ejecutarlas proporcionando un archivo .env . Como esto:

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

Usando mySQL en lugar de PostgreSQL

Instale primero el controlador MySQL.

 $ yarn add mysql

Actualice estas líneas en su archivo .env .

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

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

Puede eliminar el controlador PG si desea.

 $ yarn remove pg

Eso es todo, estás listo para rodar.

Pruebas

Para ejecutar las pruebas, necesita crear una base de datos de prueba separada. No olvide actualizar su archivo .env para incluir las conexiones para la base de datos de prueba.

 $ NODE_ENV=test yarn migrate
$ yarn test

Ejecutar pruebas con cobertura.

 $ yarn test:coverage

¿Por qué 8848?

Porque el punto más alto del mundo es de 8848 metros.

Que contribuye

Para las solicitudes de contribución y funciones, cree un problema primero.

Licencia

Express-API-ES6-Starter está bajo licencia MIT.