i-Educar

“Lançando o maior software livre educacional do Brasil!”.

Nós somos a Comunidade i-Educar e acreditamos que podemos transformar o nosso país por meio da educação. Junte-se a nós!

Conteúdo

1. Sobre o i-Educar
2. Comunicação
3. Roadmap de tecnologia
4. Como contribuir
5. Instalação
6. FAQ

Sobre i-Educar

O i-Educar é um software livre de gestão escolar totalmente on-line que permite secretários escolares, professores, coordenadores e gestores da área possam utilizar uma ferramenta que produz informações e estatísticas em tempo real, com um banco de dados centralizado e de fácil acesso, diminuindo a necessidade de uso de papel, a duplicidade de documentos, o tempo de atendimento ao cidadão e racionalizando o trabalho do servidor público.

Ele foi originalmente desenvolvido pela prefeitura de Itajaí - SC e disponibilizado no Portal do Software Público do Governo Federal em 2008, com o objetivo de atender às necessidades das Secretarias de Educação e Escolas Públicas de todo o Brasil.

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.

Roadmap de tecnologia

O i-Educar por ser um sistema antigo e por não ter seguido um padrão específico, precisa passar por um processo de melhoria para diminuir a quantidade de bugs, melhorar a manutenibilidade e enfim permitir a evolução através de features.

Passos iniciais

• Adoção do PSR1
• Adoção do PSR2
• Adoção do PSR4
• Iniciar a cobertura de testes para possibilitar refatorações

Planejamento Técnico

Em nossa wiki você encontra um planejamento mais técnico de como devemos prosseguir com as melhorias e evoluções do nosso projeto. Clique aqui para ler mais a respeito.

Como contribuir

Contribuições são super bem vindas! Se você tem vontade de construir o i-Educar junto conosco, veja o nosso guia de contribuição onde explicamos detalhadamente como trabalhamos e de que formas você pode nos ajudar a alcançar nossos objetivos.

Instalação

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

Depêndencias

Para executar o projeto é necessário a utilização de alguns softwares para facilitar o desenvolvimento.

• Docker
• Docker Compose
• Git

Instalação

Para instalar o projeto clone o repositório:

git clone https://github.com/portabilis/i-educar.git && cd i-educar

Em seguida, clone o repositório de relatórios:

git clone https://github.com/portabilis/i-educar-reports-package.git ieducar/modules/Reports

Será necessário criar os arquivos de configuração do seu ambiente, modifique-os se necessário:

cp docker-compose.yml.example docker-compose.yml
cp .env.example .env
cp ieducar/configuration/ieducar.ini.example ieducar/configuration/ieducar.ini
cp phinx.php.example phinx.php

Altere também o arquivo phinx.php, para adicionar as migrations dos relatórios:

...

$configuration = array(
    "paths" => array(
        "migrations" => array(
            "ieducar/misc/database/migrations",
            "ieducar/modules/Reports/database/migrations",   // <<<<< ADICIONAR ESTA LINHA
        ),
        "seeds" => array(
            "ieducar/misc/database/seeds",
            "ieducar/modules/Reports/database/seeds",        // <<<<< ADICIONAR ESTA LINHA
        ),
    ),
    "environments" => $environments,
);

...

Faça o build das imagens Docker utilizadas no projeto (pode levar alguns minutos):

docker-compose build

Então, inicie os containers da aplicação:

docker-compose up -d

Faça instalação das dependências do projeto execute apenas um dos comandos abaixo:

Caso você tenha o Composer instalado localmente

composer install

Senão, execute

docker run -it -v $(pwd):/app composer install

Acesse o container php para permitir a escrita nas pastas necessárias, criar a chave da aplicação, links simbólicos e finalizar a instalação do banco de dados e dos relatórios:

docker-compose exec php bash

chmod -R 777 bootstrap/cache
chmod -R 777 storage
chmod -R 777 ieducar/modules/Reports/ReportSources/Portabilis
chmod +x vendor/cossou/jasperphp/src/JasperStarter/bin/jasperstarter

php artisan key:generate
php artisan legacy:link

vendor/bin/phinx seed:run -s StartingSeed -s StartingForeignKeysSeed -s StartingReportsSeed
vendor/bin/phinx migrate

exit

Compilando arquivos do JasperReports

docker-compose exec php bash
cd ieducar/modules/Reports/ReportSources
for line in $(ls -a | sort | grep .jrxml | sed -e "s/\.jrxml//"); do $(../../../vendor/cossou/jasperphp/src/JasperStarter/bin/jasperstarter cp $line.jrxml -o $line); done

Primeiro acesso

Após realizar a instalação de acordo com as instruções acima você está pronto para fazer o seu primeiro acesso ao i-Educar, acesse o endereço:

http://localhost

O usuário padrão é: admin / A senha padrão é: 123456789

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

Utilização do Xdebug

A ferramenta Xdebug está incluída no projeto com o intuito de facilitar o processo de debug durante o desenvolvimento. Para configurá-la, modifique os valores das variáveis XDEBUG_* no arquivo docker-compose.yml conforme orientações da sua IDE de desenvolvimento.

Executando testes unitários

Para ambiente de desenvolvimento edite o arquivo ieducar/phpunit.xml e removaou comente a linha que segue:

<log type="coverage-clover" target="./tests/log/clover.xml"/>

Esta linha acima é apenas para gerar o xml de coverage para a badge do repositório.

Mantenha o coverage-html para visualizar local como está o status de coverage do projeto.

Para rodar os testes, execute o comando que segue:

docker-compose exec php vendor/bin/phpunit -c /application/ieducar/phpunit.xml 

Visualizar report de coverage

Acesse em seu navegador o arquivo index.html que consta na pasta ieducar/tests/log/report/index.html

Perguntas frequentes (FAQ)

Algumas perguntas aparecem recorrentemente. Olhe primeiro por aqui: FAQ

---

Powered by Portabilis Tecnologia