O projeto está sem receber novas atualizações desde 01/08/2020. Não sei se irei ter tempo de voltar a manter o projeto. Muitos boletins foram disponibilizados e a demanda aumenta a cada dia. Estou procurando disponibilidade para realização de uma manutenção geral e manter os dados novamente atualizados.
O COVID-RN é um projeto que visa rastrear os casos de coronavirus em todo o território do Rio Grande do Norte, informando dados únicos tanto para o estado quando para cada cidade.
Pela falta do estado não possuir uma API sobre a incidência de casos de coronavirus e pouca dinâmica na veiculação dos boletins. O projeto tem o âmbito de oferecer:
- Uma base de dados do tipo API REST de livre acesso para pesquisa e consulta
- Uma interface que disponibiliza os dados gerados para o cliente
- Gráficos e mapas com foco nos casos no RN
Com base no design dos boletins epidemiológicos lançados pela SESAP-RN, o projeto seguiu o mesmo modelo como base da estrutura dos dados. Ganhando posteiormente responsividade para diferentes telas, garantindo acesisiblidade a diferentes tipos de usuários com seus respectivos dispositivos desktop 💻 e mobile 📱.
Todas chamadas devem usar a url base:
https://covid-rn-server.herokuapp.com/api/v2
A API está usando o pacote Cors, isso permite o acesso de qualquer Interface (frontend), desde que a mesma seja direcionada para a porta adequada.
utilize a documentação para mais informações de como utilizar a API corretamente
Essas instruções fornecerão uma cópia do projeto em execução na sua máquina local para fins de desenvolvimento e teste.
O que você precisa para instalar o software:
node v12.x
yarn 1.22.4
git
Para uma melhor experiência no ambiente de testes com o servidor API REST, recomenda-se o uso do insomnia
Clonando o projeto:
git clone https://github.com/KZTN/COVID-RN.git
Navegando até a pasta do projeto:
cd COVID-RN
Crie um arquivo .env na raíz do projeto e adicione as seguintes linhas:
REACT_APP_GOOGLE_KEY= YOUR_GOOGLE_API_HERE
REACT_APP_API_URL= https://covid-rn-server.herokuapp.com/api/v2Para obter sua própria API da google, acesse: https://console.cloud.google.com/ (Recurso não obrigatório)
Baixando as dependências do projeto:
yarn installRodando o projeto:
yarn startVisite http://localhost:3000 com o seu navegador para ver o resultado. 🎉
- Faça um fork desse repositório;
- Cria uma branch com a sua feature:
git checkout -b minha-feature; - Faça commit das suas alterações:
git commit -m 'feat: Minha nova feature'; - Faça push para a sua branch:
git push origin minha-feature.
Depois que o merge da sua pull request for feito, você pode deletar a sua branch.
-
Criar uma base de dados API REST
-
Criar uma aplicação web para o projeto
-
Integração frontend com backend
-
Criar interface responsiva
-
Elaborar gráficos com base de dados
-
Elaborar mapas com base de dados
-
Deploy da aplicação
-
Desenvolver a versão 2.0 da API
-
Consultas a API por data específica
-
Elaborar um modelo epidemiológico SIR no projeto
-
Gerar estatísticas de acesso, consultas, erros e depuração
-
Criar um console de consultas à API e estátisticas de acesso
-
Gerar relatórios automáticos de status do serviço
-
Gerar mapas de contaminação por data
-
Revisão, refatoração e optimização de todo o projeto (em desenvolvimento...)
-
Elaborar gráficos com base no índice de isolamento social
-
Dicionário de buscas de cidades, melhorias de usabilidade, melhorias de navegação de mapa
-
Utilização da API PLACES do google no formulários de requisições (em desenvolvimento...)
-
Gerar backups automáticos do banco de dados
-
and more...
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
Kaio César 💻 🎨 |
Feito com ♥ by KZTN