/Cidadao-de-olho

User friendly transparency app built with Laravel using open data from Minas Gerais government

Primary LanguagePHP

Cidadão de olho

# Sobre

A aplicação Cidadão de olho é uma ferramenta que facilita a transparência no governo do estado de Minas Gerais, utilizando somente dados abertos oferecidos pelo próprio governo, sendo eles:

Arquitetura

A aplicação é separada em dois módulos principais e dependentes entre si, portanto para utilizar a aplicação em sua totalidade é necessário instalar e configurar estes módulos, sendo ambos feitos em laravel e que tem seu funcionamento sintetizado na imagem a seguir.

alt text

Cidadão de Olho

Neste módulo é onde ocorre a interação com usuários, sendo sua parte principal o front-end e conexão com a API. Cidadão de Olho

Cidadão de Olho API

Neste módulo é onde ocorre a interação incial com o web service do governo de Minas Gerais, sendo sua parte principal o back-end e as regras de negócio. Cidadão de Olho API

Instalação e configuração

Requisitos

Para instalar a aplicação será necessário:

  • PHP 7.2.*
  • Composer
  • MySQL 5^

Instalação

Após clonar o projeto você deverá utilizar os seguintes comandos:

Para instalar os pacotes do composer

composer install

Configuração

As configurações necessárias para utilizar a aplicação são as seguintes:

  • Copie o arquivo .env.example para .env
cp .env.example .env
  • Gerar a chave da aplicação
php artisan key:generate

Utilizando a aplicação localmente

Para utilizar a aplicação em localhost basta rodar o seguinte comando no terminal

  • Iniciar servidor php local
php artisan serve