Agenda Saúde

Agenda Saúde é um projeto de código aberto desenvolvido de forma colaborativa para fornecer um sistema de agendamento de vacinação e exames de COVID-19 para prefeituras. Atualmente está em uso pela secretaria de saúde da prefeitura de Joinville/SC. O sistema pode ser usado livremente, respeitando a licença de uso, para gerenciar a fila de vacinação em outras cidades.

Conheça detalhes do projeto na nossa página institucional.

Quer saber como implantar na sua cidade? Veja nosso fórum. Tire qualquer dúvida sobre o projeto. Sugira melhorias. Fique a vontade para contribuir!

• Dependências
• Desenvolvimento
• Testes
• Style Guides
• Deploy
• Contribuindo
• Licença

Dependências

Este projeto usa o framework de desenvolvimento Web Ruby on Rails e possui as seguintes dependências:

• Ruby >= 3.0.1
• Node >= 13.2.0
• PostgreSQL == 12.1
• Install Docker (documentação)
• Install Docker Compose (documentação)

Desenvolvimento

Se você quiser executar este projeto no seu ambiente de desenvolvimento, você deve clonar este código-fonte, compilá-lo e executá-lo localmente.

Existem duas formas de configurar o projeto no seu ambiente. Usando o Docker Compose ou instalando manualmente as dependências.

Docker Compose

A forma mais fácil de executar este projeto no seu ambiente é usando o Docker Compose, ferramenta responsável por criar um ambiente virtualizado e instalar todas as outras dependências.

Após clonar o repositório, você pode executar os seguintes comandos no diretório da aplicação:

docker-compose up --build
docker-compose run web rails db:migrate

E acesse no ambiente local http://localhost:3000.

Inicialmente a aplicação não possui nenhum dado, para popular o banco de dados utiliza as seeds:

docker-compose run web rails db:seed

Obs.: Você pode omitir a opção --build depois de fazer o build da aplicação pela primeira vez. Dessa forma, subir o docker-compose fica consideravelmente mais rápido. Porém, quando há mudanças no Gemfile, é aconselhável executar com --build novamente.

Instalando manualmente

Caso você queira instalar manualmente todas as dependências no seu ambiente GNU/Linux, precisará executar os seguintes comandos:

apt update
apt install postgresql postgresql-contrib postgresql-server-dev-all cmake nodejs libpq-dev
gem install bundler

Para instalar as bibliotecas execute:

bundle install

Para configurar o banco de dados execute:

cp .env.db.sample .env
source .env
bin/rails db:setup

E acesse no ambiente local http://localhost:3000:

bundle exec rails server

Problemas conhecidos

Caso você configure seu PostgreSQL localmente para não usar nenhuma senha, é provavável que precise alterar o método de autenticação

Testes

Para executar os testes da aplicação e verificar se tudo está funcionando como esperado execute:

bundle exec rspec

Style Guides

• Ruby style guide
• Rails style guide
• JavaScript style guide

Você pode verificar se o código está em conformidade com os padrões do projeto executando o robocop e corrigindo qualquer alerta evidenciado:

bundle exec rubocop

Contribuindo

Este projeto existe graças a todas as pessoas que contribuem. Fique a vontade para contribuir! Essas aqui são boas issues para começar! Quer conversar com o time? Estamos no Discord.

Contribuição Financeira

Deseja contribuir financeiramente? Acesse nossa página institucional. Caso sua contribuição seja menor que 500 reais, use o nosso Open Collective. Nossos financiadores:

Time

Esse projeto existe graças ao esforço e dedicação dessas pessoas:

desenvolvimento

design

Empresas parceiras

Licença

MIT