Skip to content

Commit

Permalink
Merge pull request #448 from portabilis/atualiza-readme
Browse files Browse the repository at this point in the history
Atualiza readme para uso de relatórios
  • Loading branch information
edersoares committed Oct 11, 2018
2 parents 01f308b + acf7c6b commit d3874ab
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 17 deletions.
70 changes: 54 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,12 @@ Depois de ter o Docker e git instalados faça o clone deste repositório e execu
o Docker Compose para criar os containers da aplicação:

```terminal
$ git clone https://github.com/portabilis/i-educar.git i-educar
$ cd i-educar
$ cp .env.example .env
$ cp ieducar/configuration/ieducar.ini.sample ieducar/configuration/ieducar.ini
$ cp phinx.php.sample phinx.php
$ docker-compose up -d
git clone https://github.com/portabilis/i-educar.git i-educar
cd i-educar
cp .env.example .env
cp ieducar/configuration/ieducar.ini.sample ieducar/configuration/ieducar.ini
cp phinx.php.sample phinx.php
docker-compose up -d
```

Depois disto faça as alterações necessárias nos arquivos de configuração:
Expand All @@ -118,11 +118,30 @@ com o i-Educar. Execute o seguinte comando a partir da pasta onde o i-Educar foi
clonado em sua máquina:

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

P.S.: Esses relatórios são legados e podem não funcionar. Em breve vamos lançar
um pacote de mais de 40 relatórios funcionais.
Altere também o arquivo `phinx.php`, para adicionar as migrations dos relatórios:

```php
...

$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,
);

...
```

### Instalando outras dependências

Expand All @@ -133,7 +152,7 @@ docker-compose, basta executar o comando `docker-compose up`.
Caso queira adicionar novas dependências ao projeto ou rodar algum outro
comando do composer, execute da seguinte forma na raiz do projeto:

```bash
```terminal
docker run -it -v $(pwd):/app composer <seu_comando_aqui>
```

Expand All @@ -159,22 +178,41 @@ modifique a chave `host` para `localhost` e `port` para `5434`.
Depois de ter feito a configuração do Phinx, basta rodar os seguintes comandos:

```terminal
$ docker-compose exec ieducar_1604 ieducar/vendor/bin/phinx seed:run -s StartingSeed -s StartingForeignKeysSeed
$ docker-compose exec ieducar_1604 ieducar/vendor/bin/phinx migrate
docker-compose exec ieducar_1604 ieducar/vendor/bin/phinx seed:run -s StartingSeed -s StartingForeignKeysSeed
docker-compose exec ieducar_1604 ieducar/vendor/bin/phinx migrate
```

Este comando irá executar a criação de tabelas e inserção de dados iniciais
para utilização do i-Educar.

#### Inicializando o banco de dados dos relatórios

Os relatórios também possuem sua seed inicial para o banco de dados e as migrations que são individuais por cada relatório.

Execute os seguintes comandos:

```terminal
docker-compose exec ieducar_1604 ieducar/vendor/bin/phinx seed:run -s StartingReportsSeed
docker-compose exec ieducar_1604 ieducar/vendor/bin/phinx migrate
```

### Configurando permissões

Para que tudo funcione adequadamente, principalmente a parte de relatórios, é
necessário definir algumas permissões especiais em pastas e arquivos. Use os
comandos abaixo:

```terminal
$ docker-compose exec ieducar_1604 chmod +x ieducar/vendor/portabilis/jasperphp/src/JasperStarter/bin/jasperstarter
$ docker-compose exec ieducar_1604 chmod 777 -R ieducar/modules/Reports/ReportSources/Portabilis
docker-compose exec ieducar_1604 chmod +x ieducar/vendor/cossou/jasperphp/src/JasperStarter/bin/jasperstarter
docker-compose exec ieducar_1604 chmod 777 -R ieducar/modules/Reports/ReportSources/
```

### Compilando arquivos do JasperReports

```terminal
docker-compose exec ieducar_1604 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
Expand All @@ -200,7 +238,7 @@ conforme orientações da sua IDE de desenvolvimento.
Para ambiente de desenvolvimento edite o arquivo ieducar/phpunit.xml e removaou
comente a linha que segue:
```xml
<log type="coverage-clover" target="./tests/log/clover.xml"/>
<log type="coverage-clover" target="./tests/log/clover.xml"/>
```

Esta linha acima é apenas para gerar o xml de coverage para a badge do
Expand All @@ -211,7 +249,7 @@ projeto.

Para rodar os testes, execute o comando que segue:

```bash
```terminal
docker-compose exec ieducar_1604 ieducar/vendor/bin/phpunit -c /home/portabilis/ieducar/ieducar/phpunit.xml
```

Expand Down
2 changes: 1 addition & 1 deletion ieducar/configuration/ieducar.ini.sample
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ report.show_error_details = true
report.default_factory = Portabilis_Report_ReportFactoryPHPJasper

; Define o diretório dos arquivos fontes dos relatórios
report.source_path = /home/portabilis/ieducar/ieducar/modules/Reports/ReportSources
report.source_path = /home/portabilis/ieducar/ieducar/modules/Reports/ReportSources/

; Configurações da entidade (instituicao)
; define o nome da entidade a ser exibido no topo
Expand Down

0 comments on commit d3874ab

Please sign in to comment.