API Pontos Turisticos

 

📖 Sobre

Esta API é um projeto feito durante um curso da Udemy chamado Criando poderosas API's RESTful com Django Rest Framework. Neste aprendi dominar o Django Rest Framework, uma poderosa ferramenta que torna o desenvolvimento de APIs mais produtivo e eficiente. Compreendi todos os conceitos essenciais das APIs RESTful, incluindo viewsets, serializers, respostas, permissões, autenticação por token, consumo de APIs e muito mais.

A API de Pontos Turísticos desenvolvida possui as seguintes características:

• RESTful Web API para exposição de pontos turísticos de uma região;
• Propor um novo ponto turístico;
• Moderação dos pontos turísticos cadastrados;
• Listagem básica dos pontos turísticos ( Lista resumida );
• Listagem completa dos pontos turísticos;
• Detalhe de um ponto turístico;
• Atualização de um ponto turístico por usuários autorizados;
• Deleção de um ponto turístico por usuários autorizados.

⚠️ Aviso: A API foi hospedada no Heroku apenas durante o curso, com o propósito de aprendizado.

 

💻 Tecnologias

Web

• Python 3
• Django
• Django Rest Framework

* Consulte o arquivo requirements-dev.txt para obter as dependências específicas do projeto.

Banco de Dados

• SQLite

Ferramentas e Utilitários

• IDE: PyCharm
• SGBD: Beekeeper
• Teste de API: Insomnia
• Ícones: Markdown Emoji

 

🎨 Layout

Essas são apenas algumas telas de documentação da API do Django Rest Framework.

 

🚀 Como executar o projeto

Pré-requisitos

• É essencial possuir o Python 3 instalado na máquina.
• É nescessário ter o pipenv instalado.

 

1. Faça um clone :

  $ git clone https://github.com/DevHiuryLima/Curso-de-Django.git

 

2. Instale as dependências:

• No Linux:

  $ python -m venv venv

  $ source venv/Scripts/activate

  $ ./activate

Volte para a pasta raiz e execute o comando:

  $ pip install -r requirements.txt

 

• No windows

  $ python -m venv venv

  $ cd venv\Scripts

  $ ./activate

Volte para a pasta raiz e execute o comando:

  $ pip install -r requirements.txt

 

⚠️ Aviso: Somente se faltar o Django no arquivo requirements-dev.txt, (dentro da pasta raiz) execute o comando:

  $ pip install Django

 

3. Crie as migrations e execute-as:

  $ python manage.py makemigrations

  $ python manage.py migrate

 

4. Crie um super user:

  $ python manage.py createsuperuser

 

5. Execute a aplicação

Pelo terminal na pasta raiz do projeto execute o comando.

  $ python manage.py runserver

 

Como contribuir

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

 

Voltar para o topo