Halum Hut

Halum Hut is a comprehensive e-commerce platform built with Django and Django REST Framework. It provides a robust backend API for managing vendors, products, orders, payments, and user accounts.

Features

• User Authentication: JWT-based authentication with email verification
• Vendor Management: Seller accounts, store profiles, and earnings tracking
• Product Catalog: Categories, brands, products with variants and attributes
• Shopping Cart: Cart management and wishlist functionality
• Order Processing: Order creation, tracking, and management
• Payment Integration: Support for Cash on Delivery (COD) with extensible payment methods
• Notifications: Real-time notifications using Django Channels and WebSockets
• Reviews: Product review and rating system

Documentation

• Getting Started Guide - Setup instructions and environment configuration
• API Documentation:
  • Accounts API - User registration, authentication, and profile management
  • Vendors API - Seller account management and store operations
  • Products API - Product catalog, categories, and inventory management
  • Cart API - Shopping cart and wishlist functionality
  • Orders API - Order creation, processing, and tracking
  • Payments API - Payment processing and transaction management
  • Reviews API - Product reviews and ratings
  • Notifications API - Real-time notification system
  • Admin API - Administrative operations and dashboard
• OpenAPI Specification - Complete API reference in OpenAPI 3.0 format

Quick Example

# Authentication - Get JWT token
curl -X POST http://localhost:8000/accounts/api/login/ \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "yourpassword"}'

# Response
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

# Get products
curl -X GET http://localhost:8000/products/api/products/ \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."

Project Structure

halum_hut/ ├── accounts/ # User authentication and profile management ├── cart/ # Shopping cart and wishlist functionality ├── core/ # Core utilities and shared components ├── coupons/ # Discount coupons and promotions ├── docs/ # Documentation files ├── halum_hut/ # Project settings and configuration ├── inventory/ # Inventory management ├── notifications/ # Real-time notifications with WebSockets ├── orders/ # Order processing and management ├── products/ # Product catalog and management ├── reviews/ # Product reviews and ratings ├── vendors/ # Seller accounts and store management ├── .example.env # Example environment variables ├── docker-compose.yml # Docker configuration ├── Dockerfile # Docker build instructions ├── manage.py # Django management script └── requirements.txt # Python dependencies

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/halum_hut.git
   cd halum_hut

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Copy .example.env to .env and configure environment variables:

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

5. Run migrations:

   python manage.py migrate

6. Start the development server:

   python manage.py runserver

7. For WebSocket support (notifications), run Daphne:

   daphne -p 8001 halum_hut.asgi:application

Docker Deployment

For production deployment using Docker:

# Build and start containers
docker-compose up -d
# Create superuser
docker-compose exec web python manage.py createsuperuser

Testing

Run the test suite:

python manage.py test

For coverage report:

coverage run --source='.' manage.py test
coverage report

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please read CONTRIBUTING.md for detailed guidelines.

Security

If you discover any security related issues, please email security@example.com instead of using the issue tracker.

License

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

Acknowledgments

• Django and Django REST Framework communities
• All contributors who have helped shape this project