Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/buckineer/ifta-django

This is a management solution for trucking companies to keep track of their fleet, trucks, drivers, and tax reports. This repo contains the Django backend API developed using Django-Rest-Framework
https://github.com/buckineer/ifta-django

aws-ec2 django django-rest-framework docker nginx postgresql python stripe

Last synced: 11 days ago
JSON representation

This is a management solution for trucking companies to keep track of their fleet, trucks, drivers, and tax reports. This repo contains the Django backend API developed using Django-Rest-Framework

Awesome Lists containing this project

README 

        



# IFTA Filling



![IF Logo](./.readme_assets/IFTA_Filling_Logo.png)



![Python version](https://img.shields.io/badge/Pythn-3.8.10-4c566a?logo=python&&longCache=true&logoColor=white&colorB=pink&style=flat-square&colorA=4c566a) ![Django version](https://img.shields.io/badge/Django-3.2-4c566a?logo=django&&longCache=truelogoColor=white&colorB=pink&style=flat-square&colorA=4c566a) ![Django-RestFramework](https://img.shields.io/badge/Django_Rest_Framework-4.1.10-red.svg?longCache=true&style=flat-square&logo=django&logoColor=white&colorA=4c566a&colorB=pink) 






## Table of Contents

* [Description](#intro)

* [Structure and Backend Functionalities](#structure)

* [Install (Run) with Docker](#docker)

* [Installation without Docker](#installation)

* [Deploy on VPS](#deploy)

* [Useful Links](#useful_links)





## Description



The project __IFTA FILLING__ is a managing tool for truck owners to keeps track of the _IFTA Taxes_ for their trucking business. This project has been merged into the __IFTA ya!__ solution that targets truck owner-operators instead of fleet managers.



- ### Some useful notes about the application:

    - The __User Model__ was customized to match the needs of the business. For example, a Stripe Id was added for auto payments, and username was changed to the email. Other fields needed for security features were also added.

    - __Stripe SDK__ was used to manage the User's payments.

    - __django.core.mail__ is in use to manage the email sending functionality. While to manage the __PDFs__ creation, the package __xhtml2pdf__ is in use.



- ### How do subscriptions work?



The owner of the truck buys a subscription which allows him to use the managing tools for a limited amount of time (measure in quarters as this is the natural way of submitting IFTA taxes). After this step, __IFTA Filling__ becomes available for any driver of the company to use and for the truck owner. However, each subscription plan also comes with a maximum amount of trucks and drivers that can be managed at the time. Truck owners can expand their subscription time by auto-payments or making a manual payment, for both cases __Stripe SDK__ is used.



__NOTE:__ A driver can work for several truck owners and can also drive several trucks during a quarter.





## Install (Run) with Docker



### About the Builds and Images in use:

There are currently 3 services in use: the api (Django App), the db (the postgrSQL database), and the nginx (Nginx configuration).

    - __api:__ The Django Dockerfile is in the root directory, and it has an entrypoint file that connects the backend to the database and runs migrations as well as collects the statics.

    - __db:__ This is built from the postgres:13-alpine image. The default environment variables are set in the docker-compose.yml file.

    - __nginx:__ The default configuration for nginx is inside the nginx folder in the nginx.conf file.



### Runing Docker-Compose



1. Clone the repo:

    ```bash

    git clone repository_link

    ```

1. Configure the environment variables.

    1. Copy the content of the example env file that is inside the truck_signs_designs folder into a .env file:

        ```bash

        cd ifta_filing_django_api/settings

        cp simple_env_config.env .env

        ```

    1. The new .env file should contain all the environment variables necessary to run all the django app in all the environments. However, the only needed variables for docker to run are the following:

        ```bash

        DOCKER_SECRET_KEY

        DOCKER_DB_NAME

        DOCKER_DB_USER

        DOCKER_DB_PASSWORD

        DOCKER_DB_HOST

        DOCKER_DB_PORT

        DOCKER_STRIPE_PUBLIC_KEY

        DOCKER_STRIPE_SECRET_KEY

        DOCKER_EMAIL_HOST_USER

        DOCKER_EMAIL_HOST_PASSWORD

        ```

    1. For the database, the default configurations should be:

        ```bash

        DOCKER_DB_NAME=docker_iftafilling_db

        DOCKER_DB_USER=docker_iftafillings_user

        DOCKER_DB_PASSWORD=docker_superiftafillinguser!

        DOCKER_DB_HOST=db

        DOCKER_DB_PORT=5432

        ```

    1. The DOCKER_SECRET_KEY is the django secret key. To generate a new one see: [Stackoverflow Link](https://stackoverflow.com/questions/41298963/is-there-a-function-for-generating-settings-secret-key-in-django)



    1. The DOCKER_STRIPE_PUBLISHABLE_KEY and the DOCKER_STRIPE_SECRET_KEY can be obtained from a developer account in [Stripe](https://stripe.com/). 

        - To retrieve the keys from a Stripe developer account follow the next instructions:

            1. Log in into your Stripe developer account (stripe.com) or create a new one (stripe.com > Sign Up). This should redirect to the account's Dashboard.

            1. Go to Developer > API Keys, and copy both the Publishable Key and the Secret Key.



    1. The DOCKER_EMAIL_HOST_USER and the DOCKER_EMAIL_HOST_PASSWORD are the credentials to send emails from the website when a client asks for a PDF report.



1. Run docker-compose:

    ```bash

    docker-compose up --build

    ```

1. Congratulations =) !!! The App should be running in [localhost:80](http://localhost:80)

1. (Optional step) To create a super user run:

    ```bash

    docker-compose run api ./manage.py createsuperuser

    ```





## Installation without Docker



1. Clone the repo:

    ```bash

    git clone {repository link}

    ```

1. Configure a virtual env and set up the database. See [Link for configuring Virtual Environment](https://docs.python-guide.org/dev/virtualenvs/) and [Link for Database setup](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-16-04).

1. Configure the environment variables.

    1. Copy the content of the example env file that is inside the truck_signs_designs folder into a .env file:

        ```bash

        cd truck_signs_designs/settings

        cp simple_env_config.env .env

        ```

    1. The new .env file should contain all the environment variables necessary to run all the django app in all the environments. However, the only needed variables for the development environment to run are the following:

        ```bash

        SECRET_KEY

        DB_NAME

        DB_USER

        DB_PASSWORD

        DB_HOST

        DB_PORT

        STRIPE_PUBLIC_KEY

        STRIPE_SECRET_KEY

        EMAIL_HOST_USER

        EMAIL_HOST_PASSWORD

        ```

    1. For the database, the default configurations should be:

        ```bash

        DB_NAME=iftadb

        DB_USER=iftauser

        DB_PASSWORD=SuperIfta123!

        DB_HOST=localhost

        DB_PORT=5432

        ```

    1. The SECRET_KEY is the django secret key. To generate a new one see: [Stackoverflow Link](https://stackoverflow.com/questions/41298963/is-there-a-function-for-generating-settings-secret-key-in-django)



    1. The STRIPE_PUBLISHABLE_KEY and the STRIPE_SECRET_KEY can be obtained from a developer account in [Stripe](https://stripe.com/). 

        - To retrieve the keys from a Stripe developer account follow the next instructions:

            1. Log in into your Stripe developer account (stripe.com) or create a new one (stripe.com > Sign Up). This should redirect to the account's Dashboard.

            1. Go to Developer > API Keys, and copy both the Publishable Key and the Secret Key.



    1. The EMAIL_HOST_USER and the EMAIL_HOST_PASSWORD are the credentials to send emails from the website when a client asks for a PDF report.



1. Run the migrations and then the app:

    ```bash

    python manage.py migrate

    python manage.py runserver

    ```

1. Congratulations =) !!! The App should be running in [localhost:8000](http://localhost:8000)

1. (Optional step) To create a super user run:

    ```bash

    python manage.py createsuperuser





## Deploy on VPS

1. Clone the repo:

    ```bash

    git clone repository_link

    ```

1. Install the dependencies:

    ```bash

    sudo apt-get update

    sudo apt-get install python3-pip python3-dev libpq-dev postgresql postgresql-contrib nginx

    ```

1. Set up the postgresql database [Setup Database](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-16-04)

1. Create an .env file and configure the environment variables

1. Create a virtual env and activate it:

    ```bash

    virtualenv myprojectenv

    source myprojectenv/bin/activate

    ```

1. Pip install the requirements:

    ```bash

    pip install -r requirements.txt

    ```

1. Pip install gunicorn:

    ```bash

    pip install gunicorn

    ```

1. Run the migrations and then test the the app:

    ```bash

    python manage.py migrate

    python manage.py runserver

    ```

1. Complete the setup of the website with this [Link](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-16-04)

1. Configure the CORS to allow the Frontend to make api calls. See [Link](https://www.stackhawk.com/blog/django-cors-guide/)





## Useful Links

### Postgresql Databse

- Setup Database: [Digital Ocean Link for Django Deployment on VPS](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-16-04)

### Docker

- [Docker Oficial Documentation](https://docs.docker.com/)

- Dockerizing Django, PostgreSQL, guinicorn, and Nginx:

    - Github repo of sunilale0: [Link](https://github.com/sunilale0/django-postgresql-gunicorn-nginx-dockerized/blob/master/README.md#nginx)    

    - Michael Herman article on testdriven.io: [Link](https://testdriven.io/blog/dockerizing-django-with-postgres-gunicorn-and-nginx/)

### Django and DRF

- [Django Official Documentation](https://docs.djangoproject.com/en/4.0/)

- Generate a new secret key: [Stackoverflow Link](https://stackoverflow.com/questions/41298963/is-there-a-function-for-generating-settings-secret-key-in-django)

- Modify the Django Admin:

    - Small modifications (add searching, columns, ...): [Link](https://realpython.com/customize-django-admin-python/)

    - Modify Templates and css: [Link from Medium](https://medium.com/@brianmayrose/django-step-9-180d04a4152c)

- [Django Rest Framework Official Documentation](https://www.django-rest-framework.org/)

- More about Nested Serializers: [Stackoverflow Link](https://stackoverflow.com/questions/51182823/django-rest-framework-nested-serializers)

- More about GenericViews: [Testdriver.io Link](https://testdriven.io/blog/drf-views-part-2/)

### Miscellaneous

- Create Virual Environment with Virtualenv and Virtualenvwrapper: [Link](https://docs.python-guide.org/dev/virtualenvs/)

- [Configure CORS](https://www.stackhawk.com/blog/django-cors-guide/)

- [Setup Django with Cloudinary](https://cloudinary.com/documentation/django_integration)