From 0867600ad690f4f531011b8d7998c147f7ea845b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mariana=20P=C3=ADcolo?= Date: Mon, 24 Sep 2018 20:29:05 -0300 Subject: [PATCH] Update readme --- README.md | 52 ++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7a4afb0..9b315bb 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,52 @@ -[![Build Status](https://travis-ci.org/Kalkuli/2018.2-Kalkuli_Interpretation.svg?branch=master -)](https://travis-ci.com/Kalkuli/2018.2-Kalkuli_Interpretation) -# 2018.2-Kalkuli_Extraction -Microsserviço para a extração de texto de notas fiscais escaneadas. +# Serviço de Extração de Texto de Notas Fiscais -## Instalação +
- sudo docker-compose -f docker-compose-dev.yml build - -## Uso - sudo docker-compose -f docker-compose-dev.yml up + + + + + +
+ + +# Configurando o ambiente +Para instruções de como instalar o _Docker_ e o _Docker-compose_ clique [aqui](https://github.com/Kalkuli/2018.2-Kalkuli_Front-End/blob/master/README.md). + + +## Colocando no ar +Com o _Docker_ e _Docker-Compose_ instalados, basta apenas utilizar os comandos: + +``` +docker-compose -f docker-compose-dev.yml build +``` + +e + +``` +docker-compose -f docker-compose-dev.yml up +``` -As rotas estarão disponíveis através de localhost:5001 + +As rotas estarão disponíveis através de [localhost:5001](http://localhost:5001/). ## Testando Para rodar os testes utilize o comando: -```docker-compose -f docker-compose-dev.yml run base python3.6 manage.py test``` +``` +docker-compose -f docker-compose-dev.yml run base python3.6 manage.py test +``` E para saber a cobertura dos testes utilize: -```docker-compose -f docker-compose-dev.yml run base python3.6 manage.py cov``` +``` +docker-compose -f docker-compose-dev.yml run base python3.6 manage.py cov +``` -Para acessar a visualização do HTML coverage no browser, acesse a pasta htmlcov e abra o arquivo index.html no navegador, ou utilize o comando: +Para acessar a visualização do _HTML coverage_ no _browser_, acesse a pasta htmlcov e abra o arquivo index.html no navegador, ou utilize o comando: -```google-chrome ./htmlcov/index.html``` \ No newline at end of file +``` +google-chrome ./htmlcov/index.html +``` \ No newline at end of file