Stock Trader

An API for the inventory management of SME. A multiple-user type project mimic of a point of sale.

This project handles inventory between an SME and a warehouse. It boasts of having different user type access and automatic restocking of items at a pre-defined level from the stall.

Local setup

Clone the application, install requirements and run the local server

pip install -r requirements.txt
python manage.py runserver

To access the api:

127.0.0.1:8000/api/v1/

For documentation:

127.0.0.1:8000/api/v1/docs

Current users:

Retailer

username: retailer
email: retailer@mail.com
password: retailer

Warehouse attendant

username: attendant2
email: attendant2@mail.com
password: attendant2

To make a product sale, make a patch request to the product endpoint , changing the product amount as needed.

To make a dispatch from the warehouse, make a similar update request to tehe reorder endpoint changing the status of the reorder.

Contribution

To contribute to this project, please fork the repository and make a pull request.

pre-commit install

Run against all files

pre-commit run --all-files

Tests

pytest

More Documentation

For development using django and articles around software engineering, please visit TheGreenCodes.