Skip to content

Latest commit

 

History

History
108 lines (82 loc) · 5.58 KB

README.md

File metadata and controls

108 lines (82 loc) · 5.58 KB
Raw

Build Status Test Coverage

linguagem-simples


acompanhe

Click here to see the English version

Sobre o projeto

O projeto Linguagem Simples (posteriormente renomeado para Plenário Simples) é uma iniciativa do Laboratório Hacker da Câmara dos Deputados para tornar mais fácil a compreensão da rotina dos deputados e das discussões que acontecem no plenário da Câmara, por meio de uma linha do tempo que cobre os eventos que acontecem no plenário da câmara em tempo real. Este repositório contém o código de front-end da plataforma que permite aos jornalistas da Casa inserir novas atualizações na linha do tempo. Além disso, este é um projeto derivado dos levantamentos feitos durante o Nós do Lab , respondendo aos desafios levantados pela sociedade para a gestão de transparência, participação e cidadania do legislativo brasileiro.

Pré-requisitos

É necessário ter instalados os seguintes softwares para executar utilizando o Docker:

Para executar localmente, é necessário:

  • Node versão 10 ou superior
  • React versão 16.13.1

Comandos para executar o projeto

  1. Clone o projeto
git clone https://github.com/labhackercd/linguagem-simples-backend.git
  1. Entre dentro da pasta raiz do projeto
cd linguagem-simples-front
  1. Execute o comando para iniciar os containers
docker-compose up
  1. Para versão de desenvolvimento, execute o comando
docker-compose up dev

A API neste momento já vai estar rodando na porta 3000 do localhost.

Como rodar os testes do projeto

  • Com o projeto já em execução rode o comando:
sudo docker-compose exec dev /bin/bash -c "npm run test -- --coverage --watchAll=false"

Documentação

Devido a arquitetura escolhida pela equipe (com front e backend desacoplados entre si), e por uma questão de organização, o desenvolvimento deste projeto utilizou a metodologia ágil Scrum, e os documentos gerados podem ser acessados na nossa Wiki

About the project

The Linguagem Simples (Plain Language) project (which was later rebranded to Plenário Simples ( Simple Plenary ) is an initiative of the National Congress Of Brazil's Laboratório Hacker ( Hacker Lab ) to make understanding of the day-to-day routine of the representatives and discussions of the brazilian legislative house more accessible to citizens by providing them with an easy-to-understand timeline of events happening in plenary's sessions. This repo contains the front-end code for the platform which allows in-house journalists to update the timeline with content (such as text, image, tweets and so on) that allow for citizens to have a better understanding of the law-making process. This project derives directly from the Nós do Lab event, which engaged multiple sectors of the society to help us disrupt the work processes behind the Brazilian Legislative House with a focus on transparency, participation and citizenship.

Pre-requisites

In order to run the project via Docker the following software packages need to be installed:

In order to run the project locally the following software packages are necessary:

  • Node version 10 or higher
  • React version 16.13.1

How to run the project

  1. Clone this repo
git clone https://github.com/labhackercd/linguagem-simples-backend.git
  1. Enter the project's root directory
cd linguagem-simples-front
  1. Start up the docker instance
docker-compose up
  1. To run the development version, run the following command
docker-compose up dev

How to run tests.

  • run the following command when the Docker container is already up:
sudo docker-compose exec dev /bin/bash -c "npm run test -- --coverage --watchAll=false"

Documentation

Due to the decoupled architecture chosen by team (with separate repositories for back and front-end code) and to the use of the SCRUM agile methodology, the documentation of this project happened in our Wiki