El Royale API

API RESTFul de gerenciamento de cadastro de hotéis, desenvolvida para o desafio da Stopover.

O nome El Royale é inspirado no filme: Maus Momentos no Hotel Royale de 2018.

Descrição

As instruções a seguir apresentam como rodar o projeto em sua máquina.

Pré-requisitos

É preciso ter o Docker e o Docker Compose instalados.

Por exemplo, no Arch Linux:

sudo pacman -S docker docker-compose

Inicialização

Clone o repositório:

git clone https://github.com/robsonsilv4/ElRoyale.git && cd ElRoyale

Após, execute as migrations e inicie o container:

docker-compose run web python /code/manage.py migrate --noinput

docker-compose up -d --build

Caso queira criar um usuário administrador, execute:

docker-compose run web python /code/manage.py createsuperuser

Para carregar os dados iniciais do banco, execute:

docker-compose run web python /code/manage.py loaddata fixtures.json

Documentação e testes

A documentação está dispovível em api/v1/docs/.

Se deseja acessar os recursos utilizando o browser (navegador), há uma interface web disponível.

Os testes podem ser realizados com o Postman, utilizando a collection de exemplo.

Estilo de código

O projeto utiliza o guia de estilos do PEP8.

Feito utilizando

• Docker
• Docker Compose
• Python
• Pipenv
• Django
• Usuário Customizado
• Django REST Framework
• CORS
• JWT
• Filtros
• PostgreSQL
• SQLite3
• Postman
• Arch Linux
• Visual Studio Code

Autor

• Robson Silva - robsonsilv4

Licença

Esse projeto está licensiado sob os termos da licença do MIT - veja o arquivo LICENSE.md para mais detalhes.