An open API service indexing awesome lists of open source software.

https://github.com/isharax9/ecommerce-web-application

Fully functional e-Commerce web application with payment gateway. Please take your time and read the Readme file. A ⭐ would be appreciated!
https://github.com/isharax9/ecommerce-web-application

ecommerce ecommerce-website payment-gateway pure-php

Last synced: about 1 year ago
JSON representation

Fully functional e-Commerce web application with payment gateway. Please take your time and read the Readme file. A ⭐ would be appreciated!

Awesome Lists containing this project

README

          

# mkshop Documentation

## Table of Contents

1. [Introduction](#introduction)
2. [Features](#features)
3. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
4. [Usage](#usage)
- [User Roles](#user-roles)
- [Navigating the Application](#navigating-the-application)
- [Product Management](#product-management)
- [User Profile](#user-profile)
- [Wishlist and Cart](#wishlist-and-cart)
- [Sales Dashboard (Sellers)](#sales-dashboard-sellers)
- [Messaging (Under Construction)](#messaging-under-construction)
- [Reporting](#reporting)
5. [Technologies Used](#technologies-used)
6. [Contributing](#contributing)
7. [License](#license)
8. [mkShop-Images](#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](CONTRIBUTING.md).

## 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](LICENSE) file for details.

---
## mkShop-Images
#### ScreenShot previews for more conveniently understand the project :-

### Database ER documentation :-

![](/resourses/eshop-new-ER.png)

1\. Navigate to [http://localhost/web_project/index.php](http://localhost/web_project/index.php)

2\. Sign Up Page(registration page)

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/98523f42-bd60-4c5d-9e44-9b83bcd1cc51/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=779,406)

3\. Credentials validation part

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/1cd4d5a8-4cdf-4cc9-af29-2207f4a5843a/ascreenshot.jpeg?tl_px=844,283&br_px=1920,884&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=676,450)

4\. Sign In page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/e277060d-6c5c-4f71-9d79-605d79ba8d1b/ascreenshot.jpeg?tl_px=552,215&br_px=1627,816&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,265)

5\. Forgotten Password Function checking

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/d242cb84-3aeb-44cc-bd78-7fddf5e776a8/ascreenshot.jpeg?tl_px=844,283&br_px=1920,884&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=881,318)

6\. Reset Password Form

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/e9d31a05-bb99-4147-9d9e-1c98f2e82882/ascreenshot.jpeg?tl_px=277,0&br_px=1352,600&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,131)

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

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/28e48c14-2000-4726-9389-bb54a48068dc/ascreenshot.jpeg?tl_px=263,0&br_px=1338,600&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,247)

8\. Click "mkshop Forget Password Verification Code"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/410f2210-b51c-45fe-9286-e3f70eee01dd/ascreenshot.jpeg?tl_px=268,0&br_px=1343,600&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,206)

9\. Click "Your Verification Code is 654491ebc3db8"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/b99520b8-8bb8-469e-b36d-1df84a3d9f74/ascreenshot.jpeg?tl_px=260,136&br_px=1335,737&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,265)

10\. Click "Reset Password"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/9860d9e9-e206-4d60-a2c7-4c4f0a09ffba/ascreenshot.jpeg?tl_px=639,67&br_px=1714,668&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,265)

11\. Home Page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/c0c59ad0-b5fd-4d90-9084-14115c7717f5/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=979,248)

12\. Home page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/a850d2b6-2927-47ed-a538-2c196468507f/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=979,249)

13\. Home page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/e58bc98e-00ea-477c-a735-a8148e39ca80/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=979,249)

14\. Footer

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/2e34ac70-1b09-4cdd-bf85-e156468a4c65/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=571,368)

15\. Type "phone"

16\. Click "Search"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/a68c8bd3-16ab-4326-a9a4-cb263327abb2/ascreenshot.jpeg?tl_px=200,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=739,58)

17\. Click "Advanced"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/e54c7a2c-d827-48bb-a619-c4d7151eaadb/ascreenshot.jpeg?tl_px=200,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=913,50)

18\. Advance search feature

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/2a5007ab-f985-4d07-8d56-a4bcca897c6f/ascreenshot.jpeg?tl_px=0,0&br_px=1719,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=520,125)

19\. Type "apple"

20\. Click here.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/44ff7401-64ee-42d5-944e-dacd4d226302/ascreenshot.jpeg?tl_px=200,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=729,329)

21\. Going to my profile section

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/ce204b8d-9246-4a2f-adac-93a3fcd7a66a/ascreenshot.jpeg?tl_px=844,0&br_px=1920,600&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=810,51)

22\. Click this text field.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/ddd6c3f8-5a86-4de5-8dda-69c98f958a44/ascreenshot.jpeg?tl_px=0,0&br_px=1719,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=353,141)

23\. Type "ishara"

24\. Profile data editing and saving

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/14611dfe-3359-49b2-9c04-a7b547552a98/ascreenshot.jpeg?tl_px=432,0&br_px=1507,600&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,225)

25\. Click "Update My Profile"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/aa0af76a-f624-46f2-9110-72dfc7482ded/ascreenshot.jpeg?tl_px=364,283&br_px=1439,884&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,460)

26\. Add new products page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/c5018a38-eb00-4a50-9dce-f541f941472f/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=608,136)

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

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/25b46c14-50e5-4a78-b63e-0d261c11f8cd/ascreenshot.jpeg?tl_px=414,250&br_px=1489,851&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,265)

28\. Click the "Activate Product" field.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/29e14e0d-bab7-4db7-97aa-753a14517874/ascreenshot.jpeg?tl_px=499,0&br_px=1574,600&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,238)

29\. Watch list page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/a838b1c0-02de-49f5-beae-66293909ca37/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=582,449)

30\. Cart page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/c8bc0684-6435-4492-88ba-98911bde9b40/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=132,-6)

31\. Click "Buy Now"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/13a94d3f-47c9-44df-8f57-9cce33217072/ascreenshot.jpeg?tl_px=282,283&br_px=1357,884&force_format=png&wat_scale=95&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=502,315)

32\. Click "Pay Now"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/6e090107-0642-4683-85ba-90a112e233df/ascreenshot.jpeg?tl_px=200,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=530,431)

33\. "PayHere" Payment gateway opened

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/482bde7e-7fac-40e9-8b39-ff2fa7530765/ascreenshot.jpeg?tl_px=0,0&br_px=1719,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=484,232)

34\. Click the "Card Number" field.

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/54ecb5c4-edb9-4223-a21f-c643589b7c66/ascreenshot.jpeg?tl_px=0,0&br_px=1719,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=76,57)

35\. Click "Submit"

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/ad3d431c-f686-482a-9242-cc686f5d9bb7/ascreenshot.jpeg?tl_px=58,0&br_px=1777,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=524,432)

36\. Invoice page

![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-11-03/a23ce6a4-828c-450a-9b8f-21dc16b395cd/ascreenshot.jpeg?tl_px=0,0&br_px=1920,884&force_format=png&width=1120.0&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=922,195)
#### [Made with Scribe](https://scribehow.com/shared/mkShop__b-ZX4gj1TICgoko7bNDrnQ)