Guardiões da Saúde - Dashboards

<Insira aqui uma breve descrição sobre o que é o projeto>

Arquitetura do projeto

<Insira aqui uma imagem que demonstre como todas as tecnologias/componentes da arquitetura do projeto se relacionam>

<Agora escreva uma breve explicação de como eles se relacionam>

Como rodar o Guardiões da Saúde - Dashboards

<Inserir aqui todos os passos e comandos necessários para subir o ambiente de desenvolvimento do Guardiões - Dashboards>

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Stack de monitoramento

A stack de monitoramento utiliza o ElasticSearch e o Kibana.

Como rodar

Para rodar os serviços basta seguir o comando a seguir:

sudo docker-compose up

Por padrão já está configurado para subir o ambiente com configurações de usuário. Caso deseja terminar essa configuração, siga este tutorial: link. Caso contrário, comente a seguinte linha do arquivo /elasticsearch/elasticsearch.yml:

...
#xpack.security.enabled: true
...

Como criar usuário no Kibana com permissão de visualização

Para conseguir executar os passos a seguir, é necessário que o xpack.security esteja habilitado (olhar subseção anterior).

Criando usuário:

• Acesse o Kibana com um superuser
• Vá nas configurações (canto inferior esquerdo)
• Clique em Users (Security)
• Preencha os campos requeridos
• No campo de roles adicione as seguintes:
  • apm_system
  • kibana_dashboard_only_user
  • watcher_user

Como contribuir

Ficaremos muito felizes de receber e incorporar suas contribuições. Tem algumas informações adicionais sobre o estilo do código e a documentação.

Em geral o processo é bem simples:

• Crie uma issue descrevendo uma feature que você queira trabalhar (ou olhe as issues com o label help-wanted e good-first-issue)
• Escreva seu código, testes e documentação
• Abra um pull request descrevendo as suas alterações propostas
• Seu pull request será revisado por um dos mantenedores, que pode levantar questões para você sobre eventuais mudanças necessárias ou questões.

Como conseguir ajuda

Caso seja dúvida técnica sobre a stack do projeto, siga os passos descritos acima de como executar em modo desenvolvimento. Caso a duvida persista ou seja sobre outro assunto, abra uma issue com uma TAG no nome [duvida] que tentaremos responder o mais rápido possível.

Em caso de dúvidas em relação às tecnologias que utilizamos, sugerimos as suas próprias documentações e fóruns. Porém, sempre estamos abertos para ajudar, então comente a dificuldade que está passando na issue que está resolvendo que iremos auxiliar.

License & copyright

ProEpi, Associação Brasileira de Profissionais de Epidemiologia de Campo

Licensed under the Apache License 2.0.