KingIce StoreOS Logo # KingIce StoreOS ๐Ÿช **Enterprise Multi-Store Management Platform** A production-grade SaaS platform for managing multiple retail stores with real-time inventory tracking, point of sale, and advanced analytics. Built for Nigerian businesses. [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![Node.js](https://img.shields.io/badge/Node.js-18%2B-green.svg)](https://nodejs.org/) [![React](https://img.shields.io/badge/React-18-blue.svg)](https://react.dev/) [![MongoDB](https://img.shields.io/badge/MongoDB-Atlas-green.svg)](https://www.mongodb.com/atlas) [![TailwindCSS](https://img.shields.io/badge/Tailwind-3-06B6D4.svg)](https://tailwindcss.com/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

View Live Demo ยท Features ยท Tech Stack ยท Getting Started ยท Screenshots


๐Ÿš€ Live Demo

Service URL Status
Frontend (Vercel) kingice-storeos.vercel.app Vercel
Backend API (Render) kingice-storeos-api.onrender.com Render

Demo Credentials

Role Email Password
Super Admin [email protected] Admin@123!
Store Manager [email protected] Manager@123!
Cashier [email protected] Cashier@123!

โœจ Features

๐Ÿข Multi-Store Management

  • Centralized Dashboard: Monitor all stores from a single interface
  • Store Isolation: Data segregated per store with role-based access
  • Real-time Sync: Instant updates across all locations
  • Store Switching: Seamlessly switch between store locations

๐Ÿ“Š Advanced Analytics

  • Real-time KPIs: Revenue, profit margins, transaction counts
  • Interactive Charts: Daily, weekly, and monthly revenue trends with bar charts
  • Profit Analysis: Cost vs revenue with margin calculations
  • CSV Export: Download reports for any time period
  • Activity Log: Detailed breakdown of all business activities

๐Ÿ“ฆ Inventory Management

  • Product CRUD: Full create, read, update, delete with image upload via Cloudinary
  • Stock Tracking: Real-time quantity updates with low stock alerts
  • Barcode/SKU System: Unique product identification with auto-generation
  • Expiry Management: Automatic alerts for expiring and expired products
  • Category Organization: Hierarchical product categories
  • Bulk Import: Import hundreds of products via API

๐Ÿ’ฐ Point of Sale (POS)

  • Fast Checkout: Optimized for speed with barcode scanning
  • Multiple Payment Methods: Cash, Card, Bank Transfer
  • Receipt Generation: Professional thermal-format receipts with print support
  • Customer Tracking: Walk-in and registered customer management
  • Automatic Stock Deduction: Inventory updates instantly after each sale
  • Barcode Scanner: Camera-based and manual input support

๐Ÿ”” Smart Alert System

  • Low Stock Alerts: Automatic detection with severity levels
  • Expiry Alerts: Multi-stage alerts (30, 14, 7 days)
  • Debtor Alerts: Overdue payment notifications
  • Real-time Bell: Animated notification bell with badge counts
  • Color-coded Severity: Critical (red), Warning (amber), Info (blue)

๐Ÿ‘ฅ Debtors Management

  • Credit Sales: Track customer debts with payment history
  • Payment Recording: Record partial or full payments
  • Due Date Tracking: Automatic overdue status updates
  • Payment History: Complete audit trail of all transactions

๐Ÿ’ธ Expense Tracking

  • Expense Categories: Rent, utilities, salaries, inventory, etc.
  • Approval Workflow: Pending โ†’ Approved โ†’ Paid
  • Role-based Actions: Managers approve, Admins pay
  • Receipt Attachments: Upload and store expense documents

๐Ÿ” Security & Access Control

  • Role-Based Access: Super Admin, Manager, Cashier
  • JWT Authentication: Access + Refresh token rotation
  • Store-Level Permissions: Feature-based authorization matrix
  • Rate Limiting: API protection against abuse
  • Input Sanitization: Protection against XSS and NoSQL injection
  • Dark/Light Mode: Full theme support with persistent preference

๐Ÿ“ฑ Mobile Responsive

  • Fully Responsive: Works on desktop, tablet, and mobile
  • Collapsible Sidebar: Space-efficient navigation
  • Touch-Friendly: Optimized for mobile interactions

๐Ÿ›  Tech Stack

Frontend

Technology Purpose
React UI Framework
Vite Build Tool
TailwindCSS Styling
React Router Client-side Routing
Axios HTTP Client
Lucide Icon Library
Framer Motion Animations

Backend

Technology Purpose
Node.js Runtime
Express Web Framework
MongoDB Cloud Database
Mongoose ODM
JWT Authentication
Joi Request Validation
Winston Logging

DevOps & Services

Service Purpose
Vercel Frontend Hosting
Render Backend Hosting
MongoDB Atlas Cloud Database
Cloudinary Image Uploads
Redis Caching
GitHub Version Control

๐Ÿ“ธ Screenshots

Dashboard Analytics Point of Sale
Dashboard
Real-time KPIs, revenue charts, and alert notifications
Point of Sale
Fast POS with barcode scanner and multi-payment support
Inventory Management Analytics Page
Inventory
Product management with stock alerts and expiry tracking
Analytics
Interactive charts with daily, weekly, and monthly views

![Full Dashboard](client/public/screenshots/dashboard.png) *Complete dashboard showing multi-store analytics with dark mode*

๐Ÿš€ Getting Started

Prerequisites

  • Node.js v18.0 or higher
  • MongoDB Atlas account (free tier)
  • npm v9 or higher

Quick Start

# Clone the repository
git clone https://github.com/Kingice97/kingice-storeos.git
cd kingice-storeos

# Install server dependencies
cd server
npm install

# Create .env file
cp .env.example .env
# Edit .env with your MongoDB URI and JWT secrets

# Seed the database
node src/scripts/seed.js

# Start the server
npm run dev

# In a new terminal, install client dependencies
cd ../client
npm install

# Create .env file
cp .env.example .env

# Start the client
npm run dev

Frontend: http://localhost:5173 | Backend: http://localhost:5000

---

## ๐Ÿ“„ License

MIT License

---

<div align="center">
  <p>Built with ๐Ÿ’™ by King Ice</p>
</div>

Built With

Share this project:

Updates