Skip to content

portabilis/pre-matricula-digital

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pré-Matrícula Digital

O Pré-Matrícula Digital (PMD), módulo de gestão de vagas e listas de espera integrado ao i-Educar, agora também é de código aberto. Cumpra a Lei 14.851/2024, com gestão eficiente e transparente para sua rede.

Instalação

Para instalar o projeto execute os comandos abaixo no diretório raiz do i-Educar:

git clone git@github.com:portabilis/pre-matricula-digital.git packages/portabilis/pre-matricula-digital

cp packages/portabilis/pre-matricula-digital/.env.example packages/portabilis/pre-matricula-digital/.env

Docker

Utilizando Docker, adicione o serviço pmd ao seu arquivo docker-compose.override.yml:

services:
  
  pmd:
    container_name: ieducar-pmd
    image: node:22-alpine
    command: yarn dev --host 0.0.0.0
    ports:
      - "5173:5173"
    volumes:
      - ./packages/portabilis/pre-matricula-digital:/var/www/pre-matricula-digital
    working_dir: /var/www/pre-matricula-digital

Configure no seu arquivo .env na raíz do i-Educar:

FRONTIER_PROXY_HOST=http://host.docker.internal:5173
FRONTIER_PROXY_RULES=/pre-matricula-digital::replace(/resources/ts/main.ts,http://localhost:5173/resources/ts/main.ts)::replace(/@vite/client,http://localhost:5173/@vite/client)

Finalize a instalação do projeto:

docker compose exec php composer plug-and-play:update
docker compose exec php php artisan migrate
docker compose run --rm pmd yarn install 
docker compose down
docker compose up -d

Servidor

Instalando diretamente no seu servidor, garanta que você tenha o Yarn instalado.

apt install -y npm && npm -g install yarn

Configure no seu arquivo .env na raíz do i-Educar:

FRONTIER_ENDPOINT=/pre-matricula-digital
FRONTIER_VIEWS_PATH=packages/portabilis/pre-matricula-digital/dist

Finalize a instalação do projeto:

composer plug-and-play:update

yarn --cwd packages/portabilis/pre-matricula-digital install
yarn --cwd packages/portabilis/pre-matricula-digital build --base=/vendor/pre-matricula-digital/

php artisan migrate
php artisan vendor:publish --tag=pmd

Configurações

O Pré-Matrícula Digital pode ser configurado via variáveis de ambiente do i-Educar.

Variável Descrição
PMD_IBGE_CODES Se informado irá limitar inscrições com endereço do município
PMD_CITY Nome do município
PMD_STATE Sigla do estado
PMD_MAP_LATITUDE Latitude onde o mapa irá ser exibido
PMD_MAP_LONGITUDE Longitude onde o mapa irá ser exibido
PMD_MAP_ZOOM Zoom do mapa
PMD_LOGO URL da logo utilizada no sistema

Requisitos

Para o Pré-Matrícula Digital funcionar, alguns campos no i-Educar precisam estar preenchidos corretamente.

  1. Ano letivo aberto e em andamento
  2. As escolas devem possuir latitude e longitude cadastradas
  3. Turmas com vagas disponíveis no ano letivo
  4. Os cursos devem ter o checkbox "Importar os dados do curso para o recurso de Pré-Matrícula Digital?"
  5. As séries devem ter o checkbox "Importar os dados da série para o recurso de Pré-Matrícula Digital?"
  6. Uma chave de API válida do Google Maps com acesso a Maps JavaScript API e Geocoding API
  7. Uma chave de API válida do Froala Editor

Desenvolvimento

Este repositório contém o código-fonte da interface do usuário e do backend da aplicação e visa trazer ao projeto mais dinamicidade, tecnologia, inovação e manutenibilidade.

O Pré-Matrícula Digital é construído utilizando as tecnologias:

Dependências

Frontend

O frontend é construído utilizando Vue.js sobre os conceitos de SPA.

Backend

O backend é construído utilizando Laravel e Lighthouse sobre os conceitos de Service Provider e como um pacote para o i-Educar.


Powered by Portábilis.