contribs
🇲🇺 🇵🇰 🇳🇬 🇮🇳 🇻🇳 🇬🇭 🇬🇧

ShopCube

E-commerce and POS platform built on the Shopyo Flask framework.

• 🛒 cart
• ⭐ wishlist
• 📑 orders
• 📤 upload by csv
• 📊 charts
• 🖌️ theming

Installation

python3 -m venv venv
source venv/bin/activate
pip install shopcube

Then initialise:

shopcube initialise
shopcube run

Dashboard: http://127.0.0.1:5000/dashboard -- Email: admin@admin.com, Password: admin

Production

Git clone

pip install gunicorn
gunicorn --bind 0.0.0.0:8000 shopcube.wsgi:application

For development:

pip install -e .
shopcube initialise
flask --debug run

Environment variables:

Features

Inventory

• Products with barcode, images, colors, sizes, categories, subcategories, and vendors
• Low-stock alerts with configurable thresholds
• Stock adjustments with reason codes (manual, POS sale, return, count, PO receive)
• Purchase orders with draft, ordered, received lifecycle; auto-updates stock on receipt
• Vendor/supplier management with contact info
• Physical inventory counts with variance application
• Multi-location inventory with location management
• Stock transfers between locations
• Kit/bundle assembly from components
• Cost price and margin tracking
• Barcode label printing
• Inventory reports (valuation, low-stock, margin)

POS

• Product grid with category filtering, search, and barcode scanning
• Cart with quantity controls and running total
• Discount (percentage or fixed amount)
• Order notes
• Payment methods: Cash, Card, Other
• Auto change calculation
• Quick keys for one-tap product add
• Transaction history
• Sales reports by date, total, payment method
• Returns with receipt lookup and stock reversal
• Shift management with cash reconciliation
• Cashier role for non-admin staff

Customers

• Registration with email confirmation
• Order history per customer
• Customer groups with percentage discounts
• Customer Lifetime Value tracking (total spent, order count, AOV)

Admin

• Product CRUD with images, colors, sizes, vendor assignment
• Category and subcategory management
• Coupon management
• Delivery and payment method configuration
• Order management with status tracking and email notifications
• Bulk product upload via Excel
• Role-based access control

Security

• CSRF protection on all POST routes
• Admin-only access on management routes
• Login required for all management endpoints
• File upload type and size validation

Built on Shopyo with isolated module architecture.

E-Commerce Configuration

The shopyo_ecommerce module reads these Flask config keys. Defaults are applied automatically, override them in your config.py or instance config:

Example:

class Config:
    SHOPYO_ECOMMERCE_URL = "/shop"
    SHOPYO_ECOMMERCE_CURRENCY = "MUR"
    SHOPYO_ECOMMERCE_ITEMS_PER_PAGE = 24
    SHOPYO_ECOMMERCE_ENABLE_WISHLIST = False
    SHOPYO_ECOMMERCE_UPLOADED_PRODUCTPHOTOS_DEST = "/data/uploads/products"

Currency symbols are resolved from the ISO 4217 code via the iso4217parse package (e.g. MUR -> ₨, EUR -> €).