BizEase WebSite Backend API

This is an internship project for the tcu 3.0 cohort.

BizEase is a web app that helps businesses manage and optimize their sales processes, from inventory management to order management. It includes features like order tracking, pipeline management, reporting, and analytics. It aims to streamline sales activities, improve team collaboration, and ultimately boost sales performance.

Development

Before You get started, make sure you have Python 3.10, 3.11, or 3.12 installed and preferrably the latest release.

These are the python versions that Django 5.2.1 supports.

Create and activate a virtual environment

Create the virtual environment

python -m venv <path/to/preferred/directory>

Activate the created virtual environment depending on the platform you are working on

Install Dependencies inside the activated environment

python -m pip install -r requirements.txt

Move to proper path

• Make sure you are at the root of the repo
• Navigate into the bizease folder from the root
• Run the commands below

Configure database

Create a .env file inside the bizease directory you just navigated into. Add the following settings (without the '%' characters) to the file to configure your preferred database

USER=%db-username%
PASSWORD=%db-password%
DBNAME=%db-name%
HOST=%host-name-or-ip-address%
PORT=%port-no-the-server-is-listening-on%
DBENGINE=%django-db-engine-settings-option%

If you do not set this, the database server configuration will default to a sqlite file named 'db.sqlite3' as the db

Apply migrations as needed

python manage.py migrate

Start the development server

python manage.py runserver

Once the server is running, you can open your browser and navigate to http://localhost:8000/api-docs/ to view the apis documentation and also confirm the server is working

In case of any issue, please visit the official django docs or the official python docs for help

Code scaffolding

A Django project can contain multiple apps. Each Django app consists of a Python package that follows a certain convention and it usually handles a part of the django project e.g. Auth App. Django comes with a utility that automatically generates the basic directory structure of an app, so you can focus on writing code rather than creating directories.

To create your app, make sure you’re in the same directory as manage.py and type this command:

python manage.py startapp <app-name>

Running unit tests

python manage.py test

API Reference

Online api documentation is also availabe via this swagger UI link