mulheres-palestrantes-api

API para o site mulheres-palestrantes em Node.js usando Koa e Sequelize.

Instalação

O ambiente de desenvolvimento da aplicação utiliza Docker e Docker-Compose.

Docker-Compose

A aplicação é configurada através de variáveis de ambiente. Para isso crie o arquivo .env através do arquivo .env.sample.

  docker-compose up # constrói e executa os containers da aplicação

Banco de dados

A aplicação suporta bancos Postgres e SQLite. Para camada de cache, utiliza o Redis.

Migração

O script de versionamento de banco de dados utiliza o Umzug.

  docker-compose exec web npm run migrate up # executa as migrações do banco de dados

Seed

O seguinte comando popula o banco de dados a partir de um json no seguinte formato:

    docker-compose exec web npm run seed https://raw.githubusercontent.com/insideoutprojectbr/mulheres-palestrantes/master/mulheres.json

Execução dos testes

Os testes da aplicação usam o framework Jest.

  docker-compose exec web npm test # executa os testes unitários
  docker-compose exec web npm run lint # executa o linter Eslint

Documentação

A documentação da API está definida no formato OpenAPI(Swagger) e pode ser acessada em https://mulheres-palestrantes-api.herokuapp.com/api/docs.