izidroqueiroz/pucrio_mvp1_api

PUC Rio - Pós-Graduação em Desenvolvimento Full Stack

Sprint: Desenvolvimento Full Stack Básico

Aluno: Izidro Avelino de Queiroz Neto

Setembro/2023

ToiGet API

O objetivo da API é cadastrar banheiros, incluindo seu horário de funcionamento.

A documentação da API (padrão Swagger) pode ser consultada em http://localhost:5000/.

Como executar

Instalar as libs Python listadas em requirements.txt (ver abaixo).

Após clonar o repositório, ir ao diretório raiz e executar os comandos descritos abaixo.

É recomendado o uso de ambientes virtuais do tipo virtualenv.

(env)$ pip install -r requirements.txt

Para executar a API:

(env)$ flask run --host 0.0.0.0 --port 5000

Abra http://localhost:5000/ no navegador para verificar o status da API em execução.