Skip to content

Latest commit

 

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

LocalBuzz

LocalBuzz is a comprehensive hyperlocal e-commerce platform designed to bridge the gap between neighborhood shopkeepers and local residents. It provides a seamless discovery and shopping experience for customers while offering robust management tools for shop owners.

Core Features

For Customers

  • Shop Discovery: Browse local shops by category, location, or name.
  • Dynamic Catalog: View real-time product listings from neighborhood vendors.
  • Cart Management: Seamlessly add items from multiple shops and manage your basket.
  • Order History: Track your current and past purchases with a professional, detailed dashboard.
  • Location Services: Filter shops based on your specific vicinity.

For Shop Owners

  • Product Management: Easily add, edit, or remove products from your digital storefront.
  • Order Tracking: Manage incoming orders and update fulfilment statuses (Pending, In Progress, Ready, etc.).
  • Shop Profile: Customize your shop's details, categories, and operational status.
  • Owner Dashboard: Gain insights into your shop's performance and active orders.

Technology Stack

  • Frontend: React.js with Vite for high-performance development.
  • Backend: Node.js and Express.js providing a robust RESTful API.
  • Database: MongoDB for scalable, document-oriented data storage.
  • Authentication: Secure JWT-based authentication for both customers and owners.
  • Styling: Modern, responsive UI built with Vanilla CSS and high-end design principles.

Project Structure

LocalBuzz/
├── backend/            # Express API, Database Models, and Controllers
│   ├── controllers/    # Business logic for auth, orders, shops, and products
│   ├── middleware/     # Security and authorization filters
│   ├── models/         # Mongoose schemas (User, Shop, Product, Order)
│   └── routes/         # API endpoint definitions
└── frontend/           # React Application
    ├── src/
    │   ├── components/ # Reusable UI elements (Navbar, Footer, Cards)
    │   ├── context/    # Global state (Cart, Location)
    │   └── pages/      # Main application views

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • MongoDB (Local instance or Atlas URI)

Installation

  1. Clone the Repository

    git clone https://github.com/KHUSHI-612/Localbuzz.git
    cd Localbuzz
  2. Backend Setup

    cd backend
    npm install

    Create a .env file in the backend directory and add the following:

    MONGO_URI=your_mongodb_uri
    JWT_SECRET=your_jwt_secret
    PORT=5000
  3. Frontend Setup

    cd ../frontend
    npm install

Running the Application

  1. Start the Backend

    cd backend
    npm run dev
  2. Start the Frontend

    cd frontend
    npm run dev

    The application will be available at http://localhost:5173.

Security & Best Practices

  • Password Hashing: All user passwords are encrypted using bcryptjs.
  • Authorization: API endpoints are protected by role-based authorization checks.
  • Environment Safety: Sensitive keys are managed via environment variables and excluded from version control.

License

Distributed under the MIT License.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages