- Descrição do projeto
- Funcionalidades
- Requisitos
- Variáveis de Ambiente
- Instalação
- Primeiros passos
- Autores e histórico
- Licença
O Datasus disponibiliza informações da situação sanitária de todo Brasil, por meio do Tabnet. Neste aplicativo, os gestores conseguem realizar análises sobre questões como parto e anomalias dos recém-nascidos, a fim de quantificar e avaliar as principais necessidades de investimento na saúde pública - no caso deste projeto, do Mato Grasso do Sul.
O processo de instalação do programa, a coleta de dados, a procura específica por região estatal e a predição dos dados são pouco práticos para os gestores.
Assim, para facilitar o entendimento das principais necessidades de cada cidade do Mato Grosso do Sul, propõe-se a criação de uma plataforma web para análise de dados. Além das informações serem alimentadas periodicamente, o sistema também realizará uma predição. Tudo isso será realizado de forma visual, com o uso de gráficos.
O sistema possui como principais funcionalidades:
- Inserção de dados
- Filtragem por cidade
- Representação gráfica da principais informações de cada cidade
- Criação da parte administrativa e dos usuários (acadêmicos da iniciação científica)
- Predição de dados
Aqui você deve apresentar todos os requisitos para que sua aplicação funcione corretamente. Você também pode listar dependências opcionais, se houver.
Começe indicando qual, ou quais, sistemas operacionais são suportados. Por exemplo: Este sistema foi desenvolvido e amplamente testado em ambientes Unix ...
Para cada uma das dependências do sistema é importatne listar também a versão mínima necessária.
-
Docker (versão 20 ou superior)
- Se necessário, você pode deixar alguma observação ou instrução necessária.
-
React (versão 18.2.0)
-
Next.js (versão 17.0.2)
-
TypeScript (versão 4.8.4)
-
R (vesão 4.2 ou superior) com os seguintes pacotes:
-
compiler
-
forecast
-
fpp2
-
acp
-
tscount
-
ggplot2
-
car
-
Para correta utilização da aplicação são necessários as seguintes váriaveis de ambiente:
- SECRET_PASSWORD: uma string de 32 caracteres alfanuméricos
Nesta seção você deverá trazer um passo a passo do que é necessário para a implantação do sistema desenvolvido.
Preferencialmente, use de ferramentas que automatizem a instalação/implantação do sistema, ou partes dele. Por exemplo, se você precisa compilar os arquivos do sistema para utilizá-lo, uma ótima opção é o Make. Com ele é possível automatizar todo processo de preparação e compilaçãocom um simples comando no terminal:
makeOutras ferramentas podem, inclusive, automatizar o processo de inicialização dos serviços da ferramenta, como o Docker Compose:
docker-compose up -dSe o sistema precisa ser implantado manualmente, descreva detalhadamente os passos necessários para a correta instalação. Neste caso, u
- Abra um terminal no diretório do projeto ....
- Instale as dependências usando o comando xxxx ...
- Compile o código fonte com o comando yyyy ...
- ....
Por fim, lembre-se de destacar quando necessário quais variáveis de ambientes (do inglês environment variables) são utilizadas ou necessárias para o processo. Muitas vezes a falta destas variáveis pode causar erros e impedir a correta implantação do sistema.
Use esta seção para mostrar os primeiros passos para usar a aplicação. Lembre-se que esta parte deve ser focada no uso pelos clientes finais da aplicação, portanto, seja objetivo e use screenshots quando necessário.
Este sistema foi desenvolvido pela seguinte equipe:
- José Pedro Cândido Lopes Peres (peteryouseph@gmail.com)
- Leonardo Kazuyoshi Takahashi da Silva (lkazu@duck.com)
- Letícia Yurie Kokubu (leticia.yuurie@gmail.com)
Orientado pelo professor Hudson Silva Borges e proposto por Nathan Aratani.
⚠️ Se o projeto for de continuidade, vocẽ deverá mencionar qual e criar um link para o projeto original.
Este sistema está disponível sob a licença XXXX.
⚠️ Você deve discutir a licença com seu professor orientador!
⚠️ Lembre-se também de criar, ou alterar, o arquivo LICENSE deste repositório para refletir adequadamente a licença atual.
