Giter VIP home page Giter VIP logo

api-pepets's Introduction

APIRestful Pepets

Pepets: Plataforma para Anúncios de Animais Perdidos e Encontrados

Esta aplicação web tem como objetivo facilitar a conexão entre pessoas que perderam seus animais de estimação e aqueles que encontraram animais perdidos, promovendo uma comunidade unida para ajudar a reunir esses animais com seus tutores.

Funcionalidades

  • Uso de Token JWT para autenticação com Django Simple JWT
  • Validação de email
  • Rotas para change/reset password
  • Rotas para autenticados ou não, assim como administrativas
  • Inserção de imagem para criação de um post
  • Documentação da API usando Swagger
  • APIRestful utilizando Django Rest Framework

Observações

  • O projeto ainda esta em desenvolvimento e ainda será implementado novas funcionalidades!
  • Para criação de um usuário é enviado um link de verificação de email para o email do registro, por via de desenvolvimento este email aparece no console da aplicação, contendo o link para validação, basta abrir o link, que o usuário será validado.

Rodando localmente

Clone o projeto

  git clone https://github.com/joaoleau/api-pepets.git

Entre no diretório do projeto

  cd api-pepets

Ambiente Virtual Python

  python -m venv venv

Ative o ambiente virtual

  • No Windows:
  venv\Scripts\activate
  • No Git Bash
  source venv\Scripts\activate
  • No Linux
  source venv/bin/activate

Instale as dependências

  pip install -r requirements.txt

Configure as variaveis de ambiente

Faça os devidos ajustes no arquivo ".env-example" e depois altere seu nome para ".env"

Faça as migrações

  python .manage.py migrate

Inicie o projeto

  python .manage.py runserver

Documentação da API

Para acessar a documentação basta acessar a rota 'doc/'

  GET /doc/

Aprendizados

Este projeto me proporcionou muito conhecimento, foi e é o meu primeiro projeto desenvolvido sem nenhum acompanhamento, por tanto, foi desafiador porém ótimo para aplicação do meu aprendizado e dos conceitos vistos.

Autores

api-pepets's People

Contributors

joaoleau avatar

Watchers

 avatar

Forkers

enzomoralesl

api-pepets's Issues

Redimensionamento de Imagem

Implementar algo que redimensione a imagem inserida para um tamanho desejado. Dessa forma, evitar imagens desproporcionais e bagunçadas.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.