Resource manager -> Scooter Manager

Compatible with:

• django: 4.0.2
• djangorestframework: 3.13.1
• psycopg2-binary: 2.9.3
• drf-yasg: 1.20.0
• postgreSQL: 12.11
• docker: 20.10.7
• Django Rest Framework: 3.10, 3.11, 3.12

This application provides an api for managing a scooter rental company, being possible to create users within the system to register products and manipulate them (admins) and create users to rent the products (common users)

Features

• full scooter management (admin users)
• full user management (admin users)
• scooter rental (regular users)
• token based authentication
• the system does not allow two vehicles with the same license plate
• the system does not allow regular users to update the name, id or license plate of scooters
• the system does not allow regular users to assign their rent to another user
• the system does not allow updating the rental data (rent_date, end_rent_date, user)
• the system does not allow regular users to delete scooters, only admin users

Table of contents

Contents

• Features
• Table of contents
• Usage
  • 0. Installation
  • 1. Installation with Docker
  • 2. Quickstart

Usage

0. Installation

OBS: to install and run this project you must have postgreSQL installed and a database called resource-manager

first go to the /resource_manager/settings.py directory in the following code snippet insert:

DATABASES = {
 'default': {
     'ENGINE': 'django.db.backends.postgresql_psycopg2',
     'NAME': 'resource_manager',
     'USER': 'postgres',
     'PASSWORD': '{put your password here!}',
     'HOST': '127.0.0.1',
     'PORT': '5432',
   }
 }

with the database properly configured, let's create an env to run our application in an isolated environment:

python -m venv venv

then we will activate the virtual env

. venv/bin/activate

or

source venv/bin/activate

if you are in a windows environment, run the following command:

source venv/scripts/activate

With your virtual env activated, let's now install pipenv so that it can install our dependencies

pip install pipenv

Now we will install all project dependencies with the command:

pipenv install

With everything properly installed, it's time to upload the migrations of our database in our project, for that, run the following commands in your terminal:

python manage.py makemigrations

and then:

python manage.py migrate

finally, let's start our application

python manage.py runserver

1. Installation with Docker

To run this program with docker is very simple, just run the following command:

docker-compose up --build

2. Quickstart

with the project running access the link:

http://localhost:8000/

or the following link to a documentation on the swagger model:

http://localhost:8000/swagger/

To make good use of this project, import the scooter_rent.postman_collection.json file into your **POSTMAN and enjoy!

---

This app was created by Lucas Amorim (Little Love) 🧑‍💻🦆🐍🐉