Será necessário ter todas as libs python listadas no requirements.txt
instaladas.
Após clonar o repositório, é necessário ir ao diretório raiz, pelo terminal, para poder executar os comandos descritos abaixo.
É fortemente indicado o uso de ambientes virtuais do tipo virtualenv.
após instalar o ambiente virtual, digite o comando abaixo em seu terminal
virtualenv env
OBS: para iniciar o ambiente virtual em máquina windows, digite o comando .\env\Scripts\Activate
(env)$ pip install -r requirements.txt
Este comando instala as dependências/bibliotecas, descritas no arquivo requirements.txt
.
Para executar a API basta executar:
(env)$ flask run --host 0.0.0.0 --port 5000
Em modo de desenvolvimento é recomendado executar utilizando o parâmetro reload, que reiniciará o servidor automaticamente após uma mudança no código fonte.
(env)$ flask run --host 0.0.0.0 --port 5000 --reload
Abra o http://localhost:5000/#/ no navegador para verificar o status da API em execução.