SuperMall Web Application

Table of Contents

• Project Overview
• Features
  • Admin Features
  • User Features
• Tech Stack
• System Modules
• Project Setup
  • Prerequisites
  • Installation
• Folder Structure
• Database
• Logging
• Deployment
• Solution Design
• Testing
• Contributing
• License

Project Overview

SuperMall is a web application developed using the MERN stack (MongoDB, Express.js, React.js, Node.js) that allows merchants to advertise and sell their products, particularly focusing on rural towns. This platform enables consumers to securely update product information and make purchases from merchants. The app aims to reach a global audience and boost the business potential of rural vendors.

Key Goals:

• Empower rural towns to advertise and sell their products.
• Provide a seamless, mobile-friendly interface for users to purchase goods.
• Provide a secure and scalable platform for managing product and shop details.

Features

Admin Features:

• Login: Admins can securely log in to the system.
• Create Shop Details: Admins can create and update shop details for vendors.
• Manage Shop Details: Admins can update shop information, including product offerings.
• Manage Offers: Admins can create and manage special offers for users.
• Manage Categories and Floors: Admins can categorize products and organize them by floors.

User Features:

• Category Wise Details: Users can browse products by categories.
• Shop Details: View details of each shop and its offerings.
• Offers: View products that are on special offers.
• Product Comparison: Users can compare the prices and features of products.
• Filters: Filter products based on price, features, and other criteria.
• Shop Wise Offers: View offers specific to shops.
• Floor Wise Details: View products categorized by floor.
• View Shop Details: Users can explore shops and their product listings.

Tech Stack

• Frontend: React.js
• Backend: Node.js, Express.js
• Database: Firebase (for real-time data storage and management)
• Authentication: Firebase Authentication
• Logging: JavaScript or Python logging library
• Deployment: Vercel (for hosting the web app)

System Modules

Admin:

• Login
• Create Shop Details
• Manage Shop Details
• Manage Offer Details
• Manage Category & Floor

User:

• Category Wise Details
• List of Shop Details
• List Offer Products
• Compare Products Cost & Features
• Filter
• Shop Wise Offers
• Floor Wise Details
• View Shop Details

Project Setup

Prerequisites

• Node.js (v14.x or higher)
• npm or yarn
• Firebase account (for database and authentication)
• GitHub (for version control)

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/your-username/supermall.git