KZNTree is an inventory management Django application with RESTful API.

Create MySQL database using following steps.

1. run command mysql
2. Have to create database by using command create database kzntree;
3. creat user CREATE USER 'admin'@'localhost' IDENTIFIED BY 'root123'; GRANT ALL PRIVILEGES ON kzntree.* TO 'admin'@'localhost'; FLUSH PRIVILEGES;

(Tables will be migrated autmatically while makemigrations is called for manage.py) Follow these steps to set up and run the application locally:

1. Clone the Repository:

   git clone https://github.com/het-patel99/KZNTree.git
   cd KZNTree
   

2. Install all the requirements:

   pip install -r requirements.txt
   

3. Run Migrations

   python manage.py migrate
   

4. Start the server

   python manage.py runserver
   kzntree server should start at  http://localhost:8000.
   GO to below link for login page or register page directly and then you can interact seamlessly.
   http://localhost:8000
   http://localhost:8000/register/
   

AWS DEPLOYED LINK: http://52.207.29.118:8000

Auto-Documentation for REST APIs with DRF-Swagger in done in this Django application . Test API http://localhost:8000/swagger/

1. Home API

   Endpoint: /accounts/api/home/ Location: http://localhost:8000/api/home/

   Description: Fetches data related to inventory items.

   Request URL: http://localhost:8000/api/home/ Response Response body

       [
           {
               "id": 1,
               "sku": "ETSY-FOREST",
               "name": "Etsy Bundle Pack",
               "tags": "ESDC",
               "in_stock": 0,
               "available_stock": 0,
               "category": 1
           }
       ]
   

2. Build Dashboard API

   Endpoint: /accounts/api/build_dashboard/ Location: http://localhost:8000/api/build_dashboard/

   Description: Fetches data related to the build dashboard. Request URL: http://localhost:8000/api/build_dashboard/ Response Response body

       [
           {
               "id": 1,
               "references": "Build 3-Pack Single Beeswax Wrap for SO #1002",
               "item_group": "2-packSingle Beeswax Wrap",
               "quantity": 100,
               "cost": "525.00",
               "linked_sale_order_group": "SO #1002",
               "creation_group_date": "2023-02-24",
               "completion_group_date": null
           }
       ]
   

Django provides a simple API for adding caching to views using decorators. Below, I'll show you how you can add caching to your home and build dashboard APIs. Caching is implemented to optimize the performance of the APIs. The cache timeout is set to CACHE_TIMEOUT seconds.

# settings.py

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
        'LOCATION': 'unique-snowflake',
    }
}

@cache_page(CACHE_TIMEOUT) 
@api_view(['GET'])
def home_api(request):
    ""details""

@cache_page(CACHE_TIMEOUT)  
@api_view(['GET'])
def build_dashboard_api(request):
    ""details""