/i-diario

Lançando o maior software livre de educação do Brasil!

Primary LanguageRubyOtherNOASSERTION

Latest Release Maintainability Test Coverage

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

  • Baixar o i-Diário:
$ git clone https://github.com/portabilis/i-diario.git
$ cd i-diario
  • Copiar o exemplo de configurações de banco de dados e configurar:
$  cp config/database.sample.yml config/database.yml

Com Docker

No config/database.yml mudar o host para host: postgres.

  • Rode docker-compose up.

Por baixo dos panos, será feito:

  • setup do secret_key_base;
  • setup do banco;
  • setup das páginas de erro.

Pule para o Configuração da Aplicação.

Sem Docker

  • Instalar o Ruby 2.2.6 (Recomendamos uso de um gerenciador de versões como Rbenv ou Rvm)
  • Instalar a gem Bundler:
$ gem install bundler -v '1.17.3'
  • Instalar as gems:
$ bundle install
  • Criar e configurar o arquivo config/secrets.yml conforme o exemplo:
development:
  secret_key_base: CHAVE_SECRETA

Nota: Você pode gerar uma chave secreta usando o comando bundle exec rake secret

  • Criar o banco de dados:
$ bundle exec rake db:create
$ bundle exec rake db:migrate
  • Criar páginas de erro simples para desenvolvimento:
$ cp public/404.html.sample public/404.html
$ cp public/500.html.sample public/500.html
  • Iniciar o servidor:
$ bundle exec rails server

Configuração da Aplicação

  • Criar uma entidade:
$ bundle exec rake entity:setup NAME=prefeitura DOMAIN=localhost DATABASE=prefeitura_diario
  • Criar um usuário administrador:

Abra o rails console.

Sem docker:

$ bundle exec rails console

Com docker:

$ docker exec -it idiario bundle exec rails console

Crie um usuário administrador.

Entity.last.using_connection {
  User.create!(
    email: 'admin@domain.com.br',
    password: '123456789',
    password_confirmation: '123456789',
    status: 'actived',
    kind: 'employee',
    admin:  true
  )
}

Para acessar o sistema, use a URL http://localhost:3000

Sincronização com i-Educar

  • Acessar Configurações > Api de Integraçao e configurar os dados do sincronismo
  • Acessar Configurações > Unidades e clicar em Sincronizar
  • Acessar Calendário letivo, clicar em Sincronizar e configurar os calendários
  • Acessar Configurações > Api de Integração e clicar no botão de sincronizar

Nota: Após esses primeiros passos, recomendamos que a sincronização rode pelo menos diariamente para manter o i-Diário atualizado com o i-Educar

Rodar os testes

$ RAILS_ENV=test bundle exec rake db:create
$ RAILS_ENV=test bundle exec rake db:migrate
$ bin/rspec spec