Skip to content

Latest commit

 

History

History
309 lines (159 loc) · 16.2 KB

README.md

File metadata and controls

309 lines (159 loc) · 16.2 KB
Raw

mkshop Documentation

Table of Contents

  1. Introduction
  2. Features
  3. Getting Started
  4. Usage
  5. Technologies Used
  6. Contributing
  7. License
  8. mkShop-Images

Introduction

mkshop is a fully functional e-commerce web application designed to facilitate the buying and selling of products. It provides a seamless experience for both sellers and buyers, offering a wide range of features to enhance the online shopping experience.

Features

  • User registration and login.
  • Product home page showcasing seller's products.
  • Wishlist and cart functionality for buyers.
  • Advanced product search and full-page product search.
  • User profile management, including profile details updates.
  • Sellers can add new products with a customizable product add page.
  • Sales dashboard for sellers (under maintenance).
  • My products page for sellers to manage their listed products.
  • Watchlist page for buyers.
  • Purchase history for buyers.
  • Messaging functionality for communicating with sellers (under construction).
  • Contact administration or report issues.

Getting Started

Prerequisites

Before getting started with the application, make sure you have the following installed:

  • Web server (e.g., Apache, Nginx)
  • PHP
  • MySQL
  • Git
  • PayHere Payment Gateway API credentials

Installation

  1. Clone the repository from GitHub: https://github.com/isharax9/Ecommerce-web-application.git

  2. Create a MySQL database and configure the database connection in the application.

  3. Configure the PayHere Payment Gateway API with your credentials.

  4. Host the application on your web server.

Usage

User Roles

mkshop supports two main user roles:

  • Sellers: Users who can list and manage products.
  • Buyers: Users who can browse, add to cart, and purchase products.

Navigating the Application

  • Upon registration or login, users are directed to the home page, where they can browse products.
  • Navigation menus allow access to various features, such as the user profile, wishlist, and cart.

Product Management

  • Sellers can add new products, edit existing listings, and view their products.
  • Buyers can browse, search for, and purchase products.

User Profile

  • Users can view and update their profile details, excluding their registered email address.

Wishlist and Cart

  • Buyers can add products to their wishlist and cart for later purchase.

Sales Dashboard (Sellers)

  • Sellers can track their sales through the sales dashboard (if available).

Messaging (Under Construction)

  • Users will soon be able to send messages to sellers for inquiries.

Reporting

  • Users can contact administration for assistance or report issues.

Technologies Used

  • PHP
  • HTML5
  • JavaScript
  • CSS (Bootstrap)
  • AJAX
  • MySQL
  • Git and GitHub
  • PayHere Payment Gateway API

Contributing

If you'd like to contribute to mkshop, please follow our Contribution Guidelines.

Give a Star ⭐

Your support and feedback are highly valued, so if you find this project useful, consider giving it a star ⭐️. I appreciate your interest in my work.

License

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

mkShop-Images

ScreenShot previews for more conveniently understand the project :-

Database ER documentation :-

1. Navigate to http://localhost/web_project/index.php

2. Sign Up Page(registration page)

3. Credentials validation part

4. Sign In page

5. Forgotten Password Function checking

6. Reset Password Form

7. Add the Verification code here where sent to your mail

8. Click "mkshop Forget Password Verification Code"

9. Click "Your Verification Code is 654491ebc3db8"

10. Click "Reset Password"

11. Home Page

12. Home page

13. Home page

14. Footer

15. Type "phone"

16. Click "Search"

17. Click "Advanced"

18. Advance search feature

19. Type "apple"

20. Click here.

21. Going to my profile section

22. Click this text field.

23. Type "ishara"

24. Profile data editing and saving

25. Click "Update My Profile"

26. Add new products page

27. Add the product or service and Click "Save Product"

28. Click the "Activate Product" field.

29. Watch list page

30. Cart page

31. Click "Buy Now"

32. Click "Pay Now"

33. "PayHere" Payment gateway opened

34. Click the "Card Number" field.

35. Click "Submit"

36. Invoice page

Made with Scribe