Installment-Policy

A FastAPI project where customers can purchase products with installment policy.

API Documentation

View the Postmand API Documentation Download Instalment Policy.postman_collection.json from the repository to get the full API collection.

Admin credentials for test purpose

• Email: [email protected]
• Password: AdminSh@p

ER Diagram

Features

• OTP and Gmail-based registration
• Basic authentication with role-based authorization
• The customer can purchase a product with an installment plan
• An email notification will be sent as a reminder before n days of the installment date
• Admin can download a weekly or monthly report of the customer who has due as a CSV file or a JSON response
• Admin can view a weekly or monthly Due vs. Paid Amount chart of customers

Tech Stack

• Backend: Python, FastAPI, SQLAlchemy
• Frontend: HTML, CSS, JavaScript
• Database: PostgreSQL

Installation

1. Clone the repository:

   https://github.com/MdTanvirHossainTusher/Installment-Policy.git

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows, use: venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Copy .env.example file to .env file and fillup the blanked values

Running the Application

1. Start the development server:

   python run.py

2. Open your browser and navigate to http://localhost:8000

Using Docker

1. Build and run the Docker container:

   docker-compose up --build

2. Open your browser and navigate to http://localhost:8000

Application Overview