Skip to content

Latest commit

 

History

History
249 lines (177 loc) · 9 KB

README.md

File metadata and controls

249 lines (177 loc) · 9 KB
Raw

Logo

EZ - Shopping

A fully featured multi - vendor E - commerce website.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Workflow
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Shopping Experience Redefined

The Online Shopping System – EZ-Shopping is a web-based application. The purpose of the application is to automate and facilitate the whole process of shopping. The objective of this project is to develop a general – purpose online shopping store through which customers can buy products from the comfort of home through the Internet. As the world responds to the coronavirus (COVID-19) pandemic, we’re seeing a dramatic shift from in-person to online shopping. Consumers are relying on the digital world more than ever and businesses are forced to adapt their strategies and shift toward digital transformation with much more urgency than before. EZ-Shopping has all the facilities a user might need during online shopping. It has a variety of categories to choose from, wide ranges of products, flexible shopping cart and checkout methods. It is a multi-vendor application with separate vendor and admin portals.

A whole new shopping experience.

  • Register/Login with ease

  • Update your user profile and check the latest status of your orders

  • Download invoices for past orders

  • Get graphical view of your orders

  • Choose from a wide range of products

    • Men's Wear
    • Women's Wear
    • Kids' Wear
    • Electronics
    • Home Appliances
    • Lifestyle Products and much more...

  • A Shopping Cart with various functionalities

  • Flexible Checkout and Payment options

    • Cash-On-Delivery
    • RazorPay Online Payment Gateway

  • Order placed ? Sit back and relax. Keep checking the "My orders" page for delivery updates. The product will be delivered to your doorstep.

  • Vendor Portal

    • Register for a new vendor account
    • Fill in required details and upload the necessary documents
    • Once verified from the admin portal, vendor will have access to the vendor portal
    • Add / Update / Delete Products
    • Dispatch products in orders placed by users

  • Admin Portal

    • Secure, only one admin account provision
    • Download new vendor applications and verify them
    • Remove / Deny access to vendors
    • Once all the products of a particular order have been dispatched from its respective vendors, admin can put the order out for delivery. Order status can be updated to "Delivered", "Cancelled" etc.

  • Responsive Design

  • Extensive Bootstrap - Top Class UI interfaces

(back to top)

Built With

This project was built with the following frameworks and technologies:

(back to top)

Getting Started

Follow the steps given below to run the project locally on your system.

Prerequisites

  • npm 
    npm install npm@latest -g
npm install nodemon@latest -g

Installation

Once all the prerequisites are met, the required API Keys must be generated and dependencies must be installed.

  1. Create a RazorPay Developer Account and get the RAZORPAY_KEY_ID and RAZORPAY_KEY_SECRET credentials.

  2. Create a Cloudinary Account and obtain the API_KEY, API_SECRET and CLOUD from your dashboard.

  3. Create a free MongoDB Atlas cluster at https://www.mongodb.com/atlas

  4. Clone the repo

    git clone https://github.com/rushabhkela/EZ-Shopping.git

  5. In each of the Admin, Vendor and Client directories, perform steps 4-6.

  6. Install NPM packages

    npm install

  7. Create the .env file

    cp .env.example .env

  8. In the .env file, enter your credentials generated in the above steps and add a suitable session-key.

  9. Good to go! Start the project locally using the following command in any of the Admin, Vendor and Client directories.

    npm start
  10.  Admin Portal : http://localhost:3002
 Vendor Portal : http://localhost:3001
 Client Portal : http://localhost:3000

  11. Alternatively, you can visit the website at EZ-Shopping

(back to top)

Workflow

The below flowchart depicts the features and its connected flow in the website.

The flowchart can also be accessed at this link

flowchart

Roadmap

  • Implement Client Side Website
  • Add Multi - Vendor Functionality
  • Create Admin Portal
  • Create a graphical view dashboard for both vendor and admin
  • Add a recommenndation system

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

This project is licensed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

Rushabh Kela - +91 9834473257 - [email protected]

Project Link: https://github.com/rushabhkela/EZ-Shopping

(back to top)

Acknowledgments

(back to top)