Skip to content

Commit

Permalink
Atualizando README para instruções mais atuais;
Browse files Browse the repository at this point in the history
Refs #3633
  • Loading branch information
eberfreitas committed Jun 1, 2018
1 parent f2e8a79 commit 8196e95
Showing 1 changed file with 80 additions and 19 deletions.
99 changes: 80 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,56 @@
# i-Educar

i-Educar é um software público para gestão escolar, desenvolvido originalmente
pela Prefeitura de Itajai-SC, o qual foi disponibilizado e apoiado pelo Governo
Federal por meio do
[Portal do Software Público Brasileiro](http://www.softwarepublico.gov.br/).
_“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!**

O i-Educar é um software livre e público totalmente on-line que torna mais fácil
e prática a gestão dos processos das escolas, matrículas e dados de alunos,
apoiando os profissionais da rede de ensino e gestores a resolverem os desafios
da educação dentro e fora da sala de aula.

## TOC

1. Cenário atual
2. Sobre o i-Educar
3. Instalação
4. Solicite demonstração do software
5. Solicite prestação de serviço

## Cenário atual

No final de 2017, a Portabilis, organização que é integrante da comunidade desde
2009 e tem o papel de mantenedora do projeto, propôs uma renovação de energias
para levar o i-Educar ainda mais longe. (Leia aqui o manifesto:
[i-Educar por todo o Brasil](https://softwarepublico.gov.br/social/i-educar/blog/em-2018-queremos-o-i-educar-por-todo-o-brasil)).

No sentido desta iniciativa, está a proposta de acabar com a defasagem da versão
aberta e aumentar a aproximação com os seus usuários. No dia 31 de janeiro, a
Portabilis anunciou o apoio da Fundaço Lemann para potencializar todos esses
objetivos (Saiba mais aqui:
[Preparação do lançamento do maior software livre educacional do Brasil!](https://medium.com/portabilis/prepara%C3%A7%C3%A3o-do-lan%C3%A7amento-do-maior-software-educacional-open-source-do-brasil-305e57143372)).

### Etapas iniciais deste processo

1. Liberar na versão Comunidade as principais melhorias feitas pela Portabilis
nos últimos anos;
2. A Portabilis irá mudar seu fluxo de trabalho passando a desenvolver
diretamente no repositório da Comunidade;
3. Planejar tecnicamente o projeto, com foco em refatoração e criação de
padrões, para possibilitar o crescimento e expansão do uso do i-Educar;
4. Iniciar as refatorações propostas na fase de planejamento permitindo
contribuições de forma mais ativa;
5. Evoluir constantemente o i-Educar com ênfase nos usuários e na facilidade do
uso em redes públicas de ensino.

## Sobre o i-Educar

O i-Educar é um software livre e público para a gestão escolar que foi
desenvolvido originalmente pela Prefeitura de Itajaí-SC e disponibilizado como
Software Livre no Portal do Software Público Brasileiro
(https://softwarepublico.gov.br), onde atualmente é mantido pela Comunidade
i-Educar.

## Instalação

Expand All @@ -13,8 +60,11 @@ máquina. Para mais informações veja estes links:
- [Docker](https://docs.docker.com/install/)
- [Docker Compose](https://docs.docker.com/compose/install/)

Depois de ter o Docker instalado faça o clone deste repositório e execute o
Docker Compose para criar os containers da aplicação:
Você também vai precisar do [Git](https://git-scm.com/downloads) caso ainda não
o tenha instalado.

Depois de ter o Docker e git instalados faça o clone deste repositório e execute
o Docker Compose para criar os containers da aplicação:

```terminal
$ git clone git@github.com:portabilis/i-educar.git i-educar
Expand All @@ -41,20 +91,33 @@ dependências. O Composer já vem pré-instalado na imagem via Docker então par
instalar as dependências use os seguintes comandos:

```terminal
$ docker-compose exec ieducar_1604 bash
$ cd ieducar
$ composer install
$ exit
$ docker-compose exec ieducar_1604 composer install
```

### Inicializando o banco de dados

O próximo passo é inicializar o banco de dados do i-Educar. Para isto basta
executar os seguintes comandos:
O próximo passo é inicializar o banco de dados do i-Educar. Nós utilizamos o
[Phinx](https://phinx.org/) para executar migrações e preencher os dados em
nosso banco. O Phinx já é instalado como dependência através do composer no
passo anterior, mas é necessário configurá-lo antes de executar qualquer
comando.

Na raiz do projeto você encontra um arquivo chamado `phinx.php.sample`. Copie
este arquivo e altere seu nome para `phinx.php`. Verifique seu conteúdo e,
caso tenha feito alguma mudança na configuração do docker, modifique as
credenciais do banco de acordo com suas alterações. Caso contrário o arquivo
estará pronto para ser utilizado.

**Atenção:**

Se quiser rodar o Phinx a partir de sua própria máquina, fora de um container,
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
$ ieducar/vendor/bin/phinx seed:run -s StartingSeed -s StartingForeignKeysSeed
$ 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
Expand All @@ -71,18 +134,16 @@ $ docker-compose exec ieducar_1604 chmod +x ieducar/vendor/portabilis/jasperphp/
$ docker-compose exec ieducar_1604 chmod 777 -R ieducar/modules/Reports/ReportSources/Portabilis
```

## Primeiro acesso
### Primeiro acesso

Após realizar a instalação de acordo com as instruções acima você está pronta a
realizar seu primeiro acesso ao i-Educar. Basta acessar o seguinte endereço:

[http://localhost:8001](http://localhost:8001)

O usuário padrão é: `admin`
A senha padrão é: `123456789`
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**.
Assim que realizar seu primeiro acesso **não se esqueça de alterar a senha padrão**.

## Solicite demonstração do software

Expand Down

0 comments on commit 8196e95

Please sign in to comment.