Skip to content

Latest commit

 

History

History
183 lines (137 loc) · 5.29 KB

README.md

File metadata and controls

183 lines (137 loc) · 5.29 KB
Raw

Online Marketplace PHP

An online marketplace that allows users to buy and sell products. Users can register for an account, browse products, add products to their cart, and checkout using a payment gateway. Sellers can create and manage their own product listings, including setting the price, description, and uploading product images. Admins can manage user accounts, product listings, and orders.

Requirements

  • User registration and login with password hashing
  • User roles: buyer, seller, and admin
  • Sellers can create and manage their own product listings
  • Product listings include title, description, price, category, and images
  • Users can browse products by category and search for products by keyword
  • Users can add products to their cart and checkout using a payment gateway (e.g., PayPal)
  • Orders are tracked and stored in a database
  • Admins can manage user accounts, product listings, and orders
  • Proper use of security measures, such as input validation, SQL injection prevention, and CSRF protection
  • Efficient use of caching mechanisms, such as Redis or Memcached, to improve performance
  • Use of an MVC architecture (Not Laravel or CodeIgniter)

API Routes

Authentication:

  • POST /api/login: Authenticate user and generate access token
{
    "JWT_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "email": "ali@gmail.com",
    "password": "$2y$10$ChXlwPFkN6U/YCTQikrYeu4pRlxx6ZLe.mj0mKwkQC/UJLjfYMsZa"
 }
  • POST /api/register: Register a new user account
{
    "id": 1,
    "name": "ali",
    "email": "ali@gmail.com",
    "password": "$2y$10$ChXlwPFkN6U/YCTQikrYeu4pRlxx6ZLe.mj0mKwkQC/UJLjfYMsZa",
    "remember_token": "sskjdh2fudn1"
}

Products:

  • GET /api/products: Retrieve all products
  • GET /api/products/{id}: Retrieve a specific product by ID
  • POST /api/products: Create a new product listing
  • PUT /api/products/{id}: Update a product listing
  • DELETE /api/products/{id}: Delete a product listing

Orders:

  • GET /api/orders: Retrieve all orders
  • GET /api/orders/{id}: Retrieve a specific order by ID
  • POST /api/orders: Create a new order
  • PUT /api/orders/{id}: Update an existing order
  • DELETE /api/orders/{id}: Delete an order

Users:

  • GET /api/users: Retrieve all users
  • GET /api/users/{id}: Retrieve a specific user by ID
  • PUT /api/users/{id}: Update a user account
  • DELETE /api/users/{id}: Delete a user account

Categories:

  • GET /api/categories: Retrieve all categories
  • GET /api/categories/{id}: Retrieve a specific category by ID
  • POST /api/categories: Create a new category
  • PUT /api/categories/{id}: Update a category
  • DELETE /api/categories/{id}: Delete a category

Payments:

  • POST /api/payments: Process payment using payment gateway (With a good structure that allows us to add more gateways in the future)

Example Response:

{
    "payment_uri": "https://nextpay.org/nx/gateway/payment/267a5387-af3a-4063-8d41-87df73f38f60",
    "trans_id": "267a5387-af3a-4063-8d41-87df73f38f60"
}

Note: This is just an example, and you may need to modify the routes and methods based on the specific requirements.

Database Schema

Users

  • id: int (primary key)
  • name: varchar(255)
  • email: varchar(255)
  • password: varchar(255)
  • remember_token: varchar(100)
  • role: enum('buyer', 'seller', 'admin')
  • created_at: timestamp
  • updated_at: timestamp

Categories

  • id: int (primary key)
  • name: varchar(255)
  • created_at: timestamp
  • updated_at: timestamp

Products

  • id: int (primary key)
  • title: varchar(255)
  • description: text
  • price: decimal(8,2)
  • category_id: int (foreign key to Categories table)
  • seller_id: int (foreign key to Users table)
  • created_at: timestamp
  • updated_at: timestamp

Orders

  • `id: int (primary key)
  • `buyer_id: int (foreign key to Users table)
  • `product_id: int (foreign key to Products table)
  • `quantity: int
  • `amount: decimal(8,2)
  • `status: enum('pending', 'completed', 'cancelled')
  • `created_at: timestamp
  • `updated_at: timestamp

Payments

  • id: int (primary key)
  • order_id: int (foreign key to Orders table)
  • amount: decimal(8,2)
  • status: enum('pending', 'completed', 'failed')
  • payment_gateway: varchar(255)
  • transaction_id: varchar(255)
  • created_at: timestamp
  • updated_at: timestamp

Evaluation Criteria

  • Correctness and completeness of the implementation
  • Efficient use of caching mechanisms
  • Proper use of security measures
  • Clean and maintainable code
  • Proper use of error handling and logging
  • Good coding practices, such as adherence to coding standards and proper documentation

Installation

First step, You need to clone this repository from GitHub to your local environment:

git clone https://github.com/BaseMax/OnlineMarketplacePHP.git

Now you must run some command to install dependecies and create .env file:

composer install
cp .env.example .env

Now open .env file and fill the things that are needed.

Navigate to public folder and run below command to start serving on the localhost:

php -S localhost:5000

Authors

  • Ali Ahmadi
  • Max Base

Copyright 2023, Max Base