TPP API

Aplicação para unificar os transportes públicos de Portugal

---

Introdução

A intenção deste projecto é fornecer uma interface comum para o sistema de transporte públicos em Portugal.

O projecto consiste em 3 sub-projectos:

• Modelo entidade relacionamento
• Lógica de negócio
• Saída de dados

Dados iniciais / Migrações

Os dados iniciais disponíveis neste projecto depois das migrações são:

• Todos os distritos de Portugal
• Todas as cidades de Portugal

Requisitos

docker >= 2
docker-compose >= 1.18

Instalação

Sigam as instruções de comandos dadas abaixo:

• Façam um clone do repositório (SSH ou HTTPS)

# SSH
git clone --recurse-submodules git@github.com:tpportugal/tpp.git
# ou
#HTTPS
git clone --recurse-submodules https://github.com/tpportugal/tpp.git

• Entrem na pasta tpp e executem o script set_deployment.sh, da seguinte forma:

cd tpp/
bash set_development.sh

O script faz a migração do projecto.

Para iniciar a aplicação, sem voltar a instalar todas as dependências, escrevam no terminal, dentro da raiz do projecto:

bash start_development.sh

Depois de o projecto estar construído e a correr, podem aceder à aplicação usando uns dos endereços dados no tópico Saída de dados:

Criação de utilizador

Para aceder a plataforma em ambiente de desenvolvimento, é necessário criar primeiro um superuser, para tal basta executar o seguinte commando:

bash create_superuser.sh

Error logging

Para captarem os erros do projeto, recomendamos que utilizem o serviço Sentry. A aplicação da Sentry, Raven já se encontra instalada, basta definirem a seguinte Environment variable (variável do ambiente) com o vosso DSN:

• Atenção: apenas se encontra configurado para production

export SENTRY_DNS=vosso_dsn

Importar todos os distritos de Portugal

Para importarem todos os distritos corram este comando:

docker-compose... python manage.py import_districts

Importar todos os concelhos de Portugal

Para importarem todos os concelhos corram este comando:

docker-compose... python manage.py import_counties

Saída de dados

Visão geral da API

http://0.0.0.0:8000

API em formato de JSON

http://0.0.0.0:8000/?format=json

API em formato de GraphQL

http://0.0.0.0:8000/graphql/