# 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)
[](https://nodejs.org/)
[](https://react.dev/)
[](https://www.mongodb.com/atlas)
[](https://tailwindcss.com/)
[](CONTRIBUTING.md)
View Live Demo ยท Features ยท Tech Stack ยท Getting Started ยท Screenshots
๐ Live Demo
| Service | URL | Status |
|---|---|---|
| Frontend (Vercel) | kingice-storeos.vercel.app | |
| Backend API (Render) | kingice-storeos-api.onrender.com |
Demo Credentials
| Role | 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 |
|---|---|
| UI Framework | |
| Build Tool | |
| Styling | |
| Client-side Routing | |
| HTTP Client | |
| Icon Library | |
| Animations |
Backend
| Technology | Purpose |
|---|---|
| Runtime | |
| Web Framework | |
| Cloud Database | |
| ODM | |
| Authentication | |
| Request Validation | |
| Logging |
DevOps & Services
| Service | Purpose |
|---|---|
| Frontend Hosting | |
| Backend Hosting | |
| Cloud Database | |
| Image Uploads | |
| Caching | |
| Version Control |
๐ธ Screenshots
| Dashboard Analytics | Point of Sale |
Real-time KPIs, revenue charts, and alert notifications |
Fast POS with barcode scanner and multi-payment support |
| Inventory Management | Analytics Page |
Product management with stock alerts and expiry tracking |
Interactive charts with daily, weekly, and monthly views |
 *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>

