express api es6 starter

Aplicação inicial para construção de APIs com Express.js

Vem com:

• Recursos/módulos ES6
• ES7 ASYNC/AWAIT
• Migrações de estantes de livros e Knex
• PostGresql (padrão) com suporte para MySQL e SQLite
• Documentação da API usando swagger-ui-dist e swagger-jsdoc
• Docker Apoio ao desenvolvimento e produção
• Eslint para revestimento de código
• Solicite validação usando Joi
• Formatação de código usando mais bonita
• Gerenciamento de configuração usando dotenv
• Registro usando Winston
• Relatório de erro usando sentinela
• Testes usando mocha, supertest e chai
• VS Código Suporte de depurador embutido

---

Pré -requisitos

• Node.js
• Fio
• Npm
• PostgreSql / mysql / sqlite

Configurar

Clone o repositório, instale as dependências e comece imediatamente.

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

Faça uma cópia do .env.example como .env e atualize os detalhes do seu aplicativo e as credenciais do banco de dados. Agora, execute as migrações e semeia o banco de dados.

 $ yarn migrate
$ yarn seed

Finalmente, inicie o aplicativo.

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

Navegue para http: // localhost: 8848/api-docs/para verificar a instalação.

Criando novas migrações e sementes

Estes são os comandos para criar uma nova migração e arquivo de semente correspondente.

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

Exemplo,

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

Usando o docker

Usando o Docker-Compose

Use o Docker-Comppose para criar rapidamente uma pilha com o contêiner de banco de dados PostGres pré-configurado. Os dados são efêmeros e os contêineres desaparecerão quando a pilha for removida.

Configuração específica para o Docker está em .env.docker

• 0.0.0.0 como $APP_HOST para expor o aplicativo na interface de rede Docker
• Configurações de Postgres pré -configuradas - podem ser atualizadas para apontar para outro host Postgres

Traga a pilha,

 $ docker-compose up

Navegue para http: // localhost: 8848/api-docs/para verificar o aplicativo está sendo executado do Docker.

Derrubar a pilha,

 $ docker-compose down

Compilações do Docker de vários estágios

Existem vários alvos de construção disponíveis para diferentes estágios. Essas imagens podem ser usadas para implantar ou executar trabalhos em diferentes infraestruturas em nuvem baseadas em contêineres, como Kubernetes, AWS ECS, Fargate, GCP Cloud Run etc.

1. Construindo uma imagem de produção.

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

2. Construindo uma imagem para desenvolvimento.

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

3. Construindo uma imagem que executa migração e/ou reversão.

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

Depois que as imagens foram construídas - tudo o que você precisa fazer é executá -las fornecendo um arquivo .env . Assim:

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

Usando MySQL em vez de PostgreSQL

Instale o driver MySQL primeiro.

 $ yarn add mysql

Atualize essas linhas no seu arquivo .env .

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

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

Você pode remover o driver PG, se quiser.

 $ yarn remove pg

É isso, você está pronto para rolar.

Testes

Para executar os testes, você precisa criar um banco de dados de teste separado. Não se esqueça de atualizar seu arquivo .env para incluir as conexões para o banco de dados de teste.

 $ NODE_ENV=test yarn migrate
$ yarn test

Execute testes com cobertura.

 $ yarn test:coverage

Por que 8848?

Porque o ponto mais alto do mundo é de 8848 metros.

Contribuindo

Para solicitações de contribuição e recurso, crie um problema primeiro.

Licença

Express-api-ES6-Starter está sob licença do MIT.