Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 4.49 KB

README.md

File metadata and controls

111 lines (75 loc) · 4.49 KB
Raw

Latest Release

i-Diário

Portal do professor integrado com o software livre i-Educar.

Comunicação

Acreditamos que o sucesso do projeto depende diretamente da interação clara e objetiva entre os membros da Comunidade. Por isso, estamos definindo algumas políticas para que estas interações nos ajudem a crescer juntos! Você pode consultar algumas destas boas práticas em nosso código de conduta.

Além disso, gostamos de meios de comunicação assíncrona, onde não há necessidade de respostas em tempo real. Isso facilita a produtividade individual dos colaboradores do projeto.

Canal de comunicação Objetivos
Fórum - Tirar dúvidas
- Discussões de como instalar a plataforma
- Discussões de como usar funcionalidades
- Suporte entre membros de comunidade
- FAQ da comunidade (sobre o produto e funcionalidades)
Issues do Github - Sugestão de novas funcionalidades
- Reportar bugs
- Discussões técnicas
Telegram - Comunicar novidades sobre o projeto
- Movimentar a comunidade
- Falar tópicos que não demandem discussões profundas

Qualquer outro grupo de discussão não é reconhecido oficialmente pela comunidade i-Educar e não terá suporte da Portabilis - mantenedora do projeto.

Instalação

Formas de fazer a instalação:

Instalação utilizando Docker

ATENÇÃO: Essa forma de instação tem o objetivo de facilitar demonstrações e desenvolvimento. Não é recomendado para ambientes de produção!

Para instalar o projeto execute todos os passos abaixo.

  • Clone o repositório:
git clone https://github.com/portabilis/i-diario.git && cd i-diario

Faça o build das imagens Docker utilizadas no projeto e inicie os containers da aplicação (pode levar alguns minutos):

docker-compose up --build

Aguarde a instalação finalizar até algo similar aparecer na tela:

idiario-puma             | * Puma version: 6.5.0 ("Sky's Version")
idiario-puma             | * Ruby version: ruby 2.6.6p146 (2020-03-31 revision 67876) [x86_64-linux]
idiario-puma             | *  Min threads: 0
idiario-puma             | *  Max threads: 5
idiario-puma             | *  Environment: development
idiario-puma             | *          PID: 1
idiario-puma             | * Listening on http://0.0.0.0:3000
idiario-puma             | Use Ctrl-C to stop

Personalizando a instalação

Você pode criar um arquivo docker-compose.override.yml para personalizar sua instalação do i-Diário.

Primeiro acesso

Acesse http://localhost:3000 ou o IP do seu servidor para fazer o seu primeiro acesso.

O usuário padrão é: admin / A senha padrão é: A123456789$.

Assim que realizar seu primeiro acesso não se esqueça de alterar a senha padrão.

Sincronização com i-Educar

Para fazer a sincronização entre i-Educar e i-Diário é necessário configurar os dados do ambiente do i-Educar em Configurações > API de Integração.

Após configurada a integração, será exibido dois botões:

  • Sincronizar: ao clicar neste botão, será somente sincronizado os dados inseridos/atualizados/deletados após a última data de sincronização.
  • Sincronização completa: ao clicar nesse botão, será feita uma sincronização de todos os dados dos últimos 2 anos. Este botão apenas é exibido para o usuário admin.

Nota: é recomendada que a sincronização seja executada diariamente para manter o i-Diário atualizado com o i-Educar

Console

Para acessar o console do Rails, execute o comando:

# (Docker) docker-compose run ruby bundle exec rails console
bundle exec rails console

Executar os testes

# (Docker) docker-compose run ruby RAILS_ENV=test bundle exec rails db:create
RAILS_ENV=test bundle exec rails db:create

# (Docker) docker-compose run ruby RAILS_ENV=test bundle exec rails db:migrate
RAILS_ENV=test bundle exec rails db:migrate
# (Docker) docker-compose run ruby bundle exec rspec --exclude-pattern 'spec/acceptance/*.feature'
bin/rspec spec