pedrosodre / no-covid-api

This project was discontinued. Documentation available at https://api-no-covid.pedrosodre.dev/

No Covid API

API pública e gratuita contendo informações atualizadas várias vezes durante o dia sobre a pandemia do COVID-19.

Descrição

O objetivo da API é permitir que mais aplicações informativas apareçam para manter a população consciente sobre o coronavírus. Ideias, sugestões ou problemas podem ser enviados através da aba de Issues do GitHub.

Requisitos

• npm
• Node.js 10.x ou superior
• Mongo 4.x ou superior
• TypeScript 3.8.x ou superior

Início rápido

1. Instale todas as dependências do projeto:

$ npm install

2. Crie um arquivo .env através do .env.example e preencha as variáveis necessárias. Por exemplo, preencha MONGODB_URL com os dados de conexão a sua instância local do MongoDB.
3. Carregue as amostras de dados contidos na pasta /db-sample no seu banco de dados. Observação: os dados de amostra já contém uma aplicação criada com a combinação de chaves sampleKey:sampleSecret, criada apenas para facilitar no seu desenvolvimento local.
4. Inicie a aplicação com o comando abaixo:

$ npm run start:dev

Testes

Para manter o nível da aplicação, qualquer novo recurso ou correção adicionadas a API deverão ter cobertura de testes unitários e end-to-end. Para isso, utilize os comandos abaixos para guiar-se:

# testes unitários
$ npm run test

# testes e2e
$ npm run test:e2e

# cobertura de testes
$ npm run test:cov

Licença

A API foi disponibilizada publicamente através da licença GPL-3.0.