rentopia

API for property rental plattform
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

This is a personal project of backend for a property rental plattform with name Rentopia

In this project the objetives are:

• Create a local database with PostgreSQL through Django ORM
• Use JWT with custom user model
• Login with username, email and password
• Verifiy email for activate the user
• Colaboration with multi regional grouup of developers Frontend and Backend
• Use abstract model in all models
• USe UUID for primary keys in the models
• Create the REST API for CRUD operations through Django Rest Framework
• Use Swagger for document the REST API

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

This project use a postgreSQL local database.

Installation

1. Clone the repository

   git clone https://github.com/mikelm2020/rentopia.git

2. Create the python virtual enviroment

3. Prepare the virtual enviroment through of local requirements file in the requirements folder

   pip install -r requirements.txt

4. Create a .env file with enviroment variables in the root folder

5. The enviroment variables are used in the settings

(back to top)

Usage

The indications for use the API are:

1. Register an user in the section auth
2. Confirm email in the console
3. Login with the username, email and password in the section auth
4. Copy token refresh of the response
5. Click in authorized button
6. Paste token in value field
7. Click in Authorize button
8. Click in close button
9. Can you use the API
10. Logout in the section auth

(back to top)

Roadmap

• Add CRUD operations for booking and rating
• Terminate swagger documentation
• Add Chatbot
• Add unit testing
• Add geolocalization
• Add upload control with Cloudinary

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Miguel Angel López Monroy - @miguellopezmdev - miguel.lopezm.dev@gmail.com

(back to top)

Acknowledgments

My favorite resources used:

• Choose an Open Source License
• Django Documentation
• Django Rest Framework Documentation
• Django Class Based View Inspector
• Classy Django Rest Framework
• Platzi Platform
• Udemy Platform
• Real Python Tutorials
• Blog Developer.pe

(back to top)