NSGG Backend Documentation¶

Welcome to the NSGG Backend documentation. This documentation provides comprehensive information about the NSGG e-commerce and inventory management system's backend API and development guidelines.

Overview¶

NSGG Backend is a Django-based REST API that provides:

• User authentication and management
• Product and inventory management
• Order processing and tracking
• Advanced filtering and search capabilities
• Bulk operations support
• Caching and rate limiting
• Comprehensive test coverage

Quick Start¶

Prerequisites¶

• Python 3.12+
• PostgreSQL 15+
• Redis 7+
• Docker (optional)

Installation¶

1. Clone the repository:

   git clone https://github.com/yourusername/nsgg-backend.git
   cd nsgg-backend
   

2. Set up the environment:

   python -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   pip install -r requirements/development.txt
   

3. Configure environment variables:

   cp .env.example .env
   # Edit .env with your settings
   

4. Run migrations:

   python manage.py migrate
   

5. Start the development server:

   python manage.py runserver
   

Using Docker¶

1. Build and start services:

   docker-compose up -d
   

2. Create migrations:

   docker-compose exec web python manage.py migrate
   

API Documentation¶

The API documentation is available at:

• Swagger UI: /api/docs/
• ReDoc: /api/redoc/

Contributing¶

We welcome contributions! Please see our Contributing Guide for details.

License¶

This project is licensed under the MIT License - see the LICENSE file for details.