Skip to content

A comprehensive supermarket management system built with React.js, designed specifically for Indian retail standards with authentication system and complete POS functionality.

Notifications You must be signed in to change notification settings

SHUBHAM-410/SuperMarket-Management

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1 Commit
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

SuperMarket Pro - Indian Retail Management System

๐Ÿช A comprehensive supermarket management system built with React.js, designed specifically for Indian retail standards with authentication system and complete POS functionality.

๐Ÿš€ Features

๐Ÿ” Authentication System

  • Login/Signup System with strong password validation
  • User Account Management with secure password requirements
  • Role-based Access (Admin, Staff Member)
  • Demo Credentials for testing

๐Ÿช Core Modules

  • Dashboard - Real-time business metrics and analytics
  • Point of Sale (POS) - Complete billing and payment processing
  • Inventory Management - Product catalog with CRUD operations
  • Sales Reporting - Transaction history and revenue analytics
  • Customer Management - Customer database and purchase tracking
  • Settings - System configuration

๐Ÿ‡ฎ๐Ÿ‡ณ Indian Market Features

  • โ‚น Rupee Currency - All pricing in Indian Rupees
  • Indian Product Names - Authentic Indian brands (Amul, Tata, Britannia)
  • Local Context - Indian names, phone numbers, and suppliers
  • Indian Date Format - DD-MM-YYYY format

๐Ÿ’ป Technical Features

  • Responsive Design - Works on desktop, tablet, and mobile
  • Real-time Updates - Inventory updates after each sale
  • Search & Filter - Advanced product and customer search
  • Data Validation - Comprehensive form validation
  • Modern UI - Clean, professional interface with Tailwind CSS

๐Ÿ› ๏ธ Technology Stack

  • Frontend: React 18.x
  • Styling: Tailwind CSS
  • Icons: Lucide React
  • Build Tool: Webpack 5
  • Language: JavaScript (ES6+)
  • Package Manager: npm

๐Ÿ“‹ Prerequisites

Before running this project, make sure you have:

  • Node.js (version 14.x or higher)
  • npm (version 6.x or higher)
  • Git (for cloning the repository)

๐Ÿš€ Installation & Setup

1. Clone the Repository

git clone https://github.com/your-username/supermarket-management-system.git
cd supermarket-management-system

2. Install Dependencies

npm install

3. Start Development Server

npm start

The application will open at http://localhost:3000

4. Build for Production

npm run build

๐Ÿ“ Project Structure

supermarket-management-system/
โ”œโ”€โ”€ public/
โ”‚   โ””โ”€โ”€ index.html
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ App.js
โ”‚   โ””โ”€โ”€ index.js
โ”œโ”€โ”€ package.json
โ”œโ”€โ”€ webpack.config.js
โ”œโ”€โ”€ tailwind.config.js
โ”œโ”€โ”€ README.md
โ””โ”€โ”€ .gitignore

๐Ÿ”‘ Demo Credentials

Admin Account

  • Username: admin
  • Password: Admin@123

Creating New Account

When signing up, password must contain:

  • Minimum 8 characters
  • At least one uppercase letter
  • At least one lowercase letter
  • At least one number
  • At least one special character

๐ŸŽฏ How to Use

1. Authentication

  • Start with the login screen
  • Use demo credentials or create a new account
  • All new accounts are created with "Staff Member" role

2. Dashboard

  • View real-time business metrics
  • Monitor low stock items
  • Check recent transactions
  • Track daily performance

3. Point of Sale (POS)

  • Search products by name or barcode
  • Add items to cart
  • Enter customer name (optional)
  • Process payments
  • Automatic inventory updates

4. Inventory Management

  • Add new products
  • Edit existing products
  • Delete products (with confirmation)
  • Monitor stock levels
  • Color-coded stock alerts

5. Sales Reports

  • View all transactions
  • Export functionality (UI ready)
  • Revenue analytics
  • Performance metrics

6. Customer Management

  • View customer database
  • Track purchase history
  • Customer search functionality
  • Contact information management

๐Ÿ›๏ธ Sample Data

Products Include:

  • Coca Cola 330ml - โ‚น40
  • Amul Taza Milk 1L - โ‚น56
  • Tata Tea Premium 1kg - โ‚น450
  • Britannia Good Day Cookies - โ‚น30
  • Fresh Tomatoes 1kg - โ‚น25

Sample Customers:

  • Shubham Tiwary
  • Priya Sharma
  • Amit Singh

๐Ÿ“ฑ Responsive Design

The application is fully responsive and works on:

  • Desktop (1024px and above)
  • Tablet (768px - 1023px)
  • Mobile (320px - 767px)

๐Ÿ”ง Available Scripts

# Start development server
npm start

# Build for production
npm run build

# Run tests (if configured)
npm test

# Development server with webpack
npm run dev

# Production build with webpack
npm run build-prod

๐ŸŽจ Customization

Colors

Modify tailwind.config.js to change the color scheme:

colors: {
  primary: '#3B82F6',  // Blue
  secondary: '#6B7280', // Gray
  success: '#22C55E',   // Green
  warning: '#F59E0B',   // Orange
  danger: '#EF4444'     // Red
}

Branding

  • Update company name in src/App.js
  • Modify the logo in the navigation
  • Change the page title in public/index.html

๐Ÿ“š Learning Objectives

This project demonstrates:

  • React Hooks (useState, useEffect)
  • Component Architecture
  • State Management
  • Form Handling & Validation
  • Responsive Design
  • Modern JavaScript (ES6+)
  • CSS-in-JS with Tailwind
  • User Authentication Logic
  • CRUD Operations

๐Ÿ› Troubleshooting

Common Issues:

  1. npm install fails

    npm cache clean --force
    npm install
  2. Port 3000 already in use

    npm start -- --port 3001
  3. Build fails

    rm -rf node_modules package-lock.json
    npm install
    npm run build

๐Ÿค Contributing

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

๐Ÿ“ License

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

๐Ÿ‘จโ€๐Ÿ’ป Author

Your Name

๐Ÿ™ Acknowledgments

  • Lucide React for beautiful icons
  • Tailwind CSS for utility-first CSS framework
  • React Team for the amazing framework
  • College Faculty for project guidance

๐Ÿ“ž Support

For any questions or issues:

  1. Check the troubleshooting section
  2. Open an issue on GitHub
  3. Contact the author via email

Made with โค๏ธ for college project | SuperMarket Pro - Indian Retail Management System

About

A comprehensive supermarket management system built with React.js, designed specifically for Indian retail standards with authentication system and complete POS functionality.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published