🏪 Store Rating System

A comprehensive full-stack web application for store rating and management system with role-based access control.

🎯 Project Overview

The Store Rating System is a modern web application built as part of a FullStack Intern Coding Challenge. It enables users to submit ratings (1-5 stars) for registered stores with a sophisticated role-based authentication system supporting three distinct user types: System Administrators, Normal Users, and Store Owners.

🌟 Key Features

🔐 Role-Based Authentication: Secure login system with JWT tokens
⭐ Store Rating System: Interactive 1-5 star rating functionality
📊 Admin Dashboard: Comprehensive analytics and user management
🔍 Advanced Search & Filtering: Search stores by name, address, and ratings
📱 Responsive Design: Mobile-first design with TailwindCSS
🚀 Real-time Updates: Dynamic rating calculations with database triggers
🛡️ Security First: Input validation, password hashing, and CORS protection

🎥 Live Demo

🔗 Visit Live Application

🧪 Test Accounts

Role	Email	Password	Access Level
System Admin	`admin@storerating.com`	`Password123!`	Full system access
Store Owner	`owner@techmart.com`	`Password123!`	Store management
Normal User	`demouser@xyz.com`	`Demo@123`	Rating & browsing

🛠️ Tech Stack

Frontend

⚛️ React.js 18+ with TypeScript
🎨 TailwindCSS for responsive styling
🧭 React Router Dom for client-side routing
📡 Axios for API communication
⚡ Vite for fast development and building

Backend

🚀 Express.js with TypeScript
🔒 JWT authentication & authorization
🛡️ bcryptjs for password hashing
✅ express-validator for input validation
🔧 CORS & Helmet for security

Database

🐬 MySQL 8.0+ with connection pooling
☁️ Aiven Cloud for production database hosting
🔄 Database Triggers for automatic rating calculations

DevOps & Deployment

🌐 Render for frontend hosting
☁️ Cloud Platform for backend deployment
🔄 GitHub Actions ready for CI/CD

🏗️ Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│                 │    │                 │    │                 │
│   React.js      │◄──►│   Express.js    │◄──►│   MySQL DB      │
│   Frontend      │    │   Backend API   │    │   Database      │
│                 │    │                 │    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘
        │                        │                        │
        │                        │                        │
   TailwindCSS            JWT + Validation         Triggers + Indexes
   React Router            CORS + Helmet           Connection Pool

🚀 Quick Start

Prerequisites

Node.js 18+ and npm
MySQL 8.0+ database
Git for version control

1️⃣ Clone Repository

git clone https://github.com/adarsh47-bug/Store-Rating-System.git
cd Store-Rating-System

2️⃣ Backend Setup

cd backend

# Install dependencies
npm install

# Configure environment variables
cp .env.example .env
# Edit .env with your database credentials

# Setup database and sample data
npm run setup-db

# Build and start development server
npm run build
npm run dev

3️⃣ Frontend Setup

cd ../frontend

# Install dependencies
npm install --legacy-peer-deps

# Configure environment variables
cp .env.example .env
# Update VITE_API_URL if needed

# Start development server
npm start

4️⃣ Access Application

Frontend: http://localhost:5173
Backend API: http://localhost:8080
Admin Panel: Login with admin@storerating.com / Password123!

👥 User Roles & Permissions

🔱 System Administrator

✅ User Management: Create/view users and admins
✅ Store Management: Add and manage all stores
✅ Analytics Dashboard: View comprehensive statistics
✅ Advanced Filtering: Filter by name, email, address, role
✅ User Details: Access detailed user information and ratings

👤 Normal User

✅ Self Registration: Sign up with email verification
✅ Store Discovery: Browse and search stores
✅ Rating System: Submit and modify ratings (1-5 stars)
✅ Profile Management: Update password and personal info
✅ Search & Filter: Find stores by name and address

🏪 Store Owner

✅ Store Dashboard: View store analytics and ratings
✅ Rating Insights: See who rated their store
✅ Average Rating: Real-time store rating calculations
✅ Profile Management: Update password and store info

📋 API Documentation

🔐 Authentication Endpoints

POST /api/auth/login        # User login
POST /api/auth/register     # User registration
GET  /api/auth/profile      # Get user profile
PUT  /api/auth/password     # Update password

👑 Admin Endpoints

GET  /api/admin/dashboard   # Admin dashboard data
POST /api/admin/users       # Create new user
GET  /api/admin/users       # List all users
POST /api/admin/stores      # Create new store
GET  /api/admin/stores      # List all stores

👤 User Endpoints

GET  /api/user/stores       # List stores for rating
POST /api/user/ratings      # Submit store rating
GET  /api/user/ratings      # Get user's ratings

🏪 Store Owner Endpoints

GET  /api/store-owner/dashboard  # Store dashboard
GET  /api/store-owner/ratings    # Store ratings details
GET  /api/store-owner/summary    # Rating summary

🛡️ Security Features

🔒 JWT Authentication: Secure token-based authentication
🔐 Password Hashing: bcryptjs with salt rounds
✅ Input Validation: Comprehensive form validation
🛡️ CORS Protection: Cross-origin resource sharing control
🚫 SQL Injection Prevention: Parameterized queries
🔑 Role-Based Access: Route-level permission control

📊 Database Schema

Users Table

- id (Primary Key)
- name (20-60 characters)
- email (Unique, validated)
- password (Hashed, 8-16 chars with uppercase & special char)
- address (Max 400 characters)
- role (system_admin/normal_user/store_owner)
- status (Active/Inactive)
- created_at, updated_at

Stores Table

- id (Primary Key)
- name, email, address
- owner_id (Foreign Key to Users)
- average_rating (Auto-calculated)
- total_ratings (Auto-calculated)
- status, created_at, updated_at

Ratings Table

- id (Primary Key)
- user_id, store_id (Foreign Keys)
- rating (1-5, validated)
- status, created_at, updated_at
- Unique constraint: one rating per user per store

📝 Form Validations

Field	Validation Rules
Name	20-60 characters, required
Email	Valid email format, unique
Password	8-16 chars, 1 uppercase, 1 special character
Address	Maximum 400 characters
Rating	Integer between 1-5

🎨 UI/UX Features

📱 Responsive Design: Mobile-first approach
🎯 Interactive Components: Star ratings, modals, tables
🔍 Search & Filter: Real-time search functionality
📊 Data Visualization: Rating charts and statistics
🎨 Modern UI: Clean, professional interface
♿ Accessibility: ARIA labels and keyboard navigation

🚀 Deployment

Frontend (Render)

# Build command
npm run build

# Publish directory
./dist

# Environment Variables
VITE_API_URL=your_backend_url

Backend (Cloud Platform)

# Build command
npm run build

# Start command
npm start

# Environment Variables
DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME
JWT_SECRET, FRONTEND_URL

📞 Contact

Developer: Adarsh Kadam
GitHub: @adarsh47-bug
Project: Store Rating System

⭐ Star this repository if you found it helpful!

🌐 Live Demo • 📖 Documentation • 🐛 Report Bug • 💡 Feature Request

Name		Name	Last commit message	Last commit date
Latest commit History 23 Commits
.github		.github
.vscode		.vscode
backend		backend
frontend		frontend
README.md		README.md

adarsh47-bug/Store-Rating-System

Folders and files

Latest commit

History

Repository files navigation