Pywitter

Instruções Docker: 🐳

Para executar o projeto em modo de desenvolvimento com Docker e visualizar a operação, siga os passos abaixo.

Pré-requisitos:

Ferramentas necessárias para rodar o projeto:

• Docker 🐳
  Guia de Instalação do Docker.
• Docker Compose 🐳
  Guia de Instalação do Docker Compose.

Executando o Projeto com Docker:

• Primeiro configure as variáveis de ambiente a partir do arquivo .env-exemplo

• Após isso, os comandos abaixo realizam a compilação e execução do projeto:

docker-compose up --build

Esse comando irá compilar a imagem Docker e subir os contêineres para o Django e PostgreSQL, com base nas configurações definidas no docker-compose.yml.

O orquestrador possui apenas dois services (backend e db).

Para visualizar as rotas do backend, acesse localhost:8000/api/

Executando o Projeto Local:

• Backend:
  • na pasta backend/ rode os comandos:

  python -m venv venv
  venv/scripts/activate
  pip install -r ../requirements.txt
  python manage.py runserver

Para visualizar as rotas do backend, acesse localhost:8000/api/

Swagger

• Para uma melhor visualização da estrutura de APIs foi feito com Swagger.

Por joão Eduardo Braga.