Online Store Inventory and Supplier Management API

This is an API for managing the inventory and suppliers of an online store. It allows employees to add, view, update, and remove items from the inventory, manage suppliers, and establish relationships between items and suppliers.

Table of Contents

• Features
• Tech Stack
• Setup
  • Using Virtual Environment
  • Using Docker
• Running Tests
• API Documentation
• Postman Documentation

Features

• Inventory Item Management
• Supplier Management
• Item-Supplier Relationship Management
• Secure endpoints using Knox tokens
• API Documentation using Swagger
• Pagination and Filtering of inventory items

Tech Stack

• Django
• Django REST Framework
• PostgreSQL
• Docker
• Knox for token-based authentication

Setup

Using Virtual Environment

1. Clone the repository:

   git clone https://github.com/Komatech/online_store_inventory_api.git
   cd online_store_inventory_api

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. Set up the PostgreSQL database:

   • Install PostgreSQL and create a new database and user.
   • Update the env with your database credentials.

5. Create migrations:

   python manage.py makemigrations

6. Run migrations:

   python manage.py migrate

7. Create a superuser:

   python manage.py createsuperuser

8. Run the development server:

   python manage.py runserver

Using Docker

1. Clone the repository:

   git clone https://github.com/Komatech/online_store_inventory_api.git
   cd online_store_inventory_api

2. Build and run the containers:

   docker-compose up --build

Running Tests

To run the tests, use the following command:

Using Virtual Environment:

python manage.py test inventory.test

API Documentation

The API documentation is generated using Swagger. You can access it at the following URLs once the server is running:

• Swagger UI: http://localhost:8000/swagger/
• ReDoc: http://localhost:8000/redoc/

Postman Documentation

You can find the Postman documentation for this API at the following URL:

• Postman Documentation