Marketplace Application - Functional Documentation

Technical documentation

• Is located inside the Frontend and Backend repos; each one has its own documentation.

Links

• Production Link: Marketplace Production
• Frontend Repository (technical documentation is inside): Marketplace Frontend
• Backend Repository (technical documentation is inside): Marketplace Backend

Admin Account

• Email: [email protected]
• Password: 123admin

Description

The Marketplace Application is designed to connect sellers with potential buyers. It offers functionalities for sellers to register, list products, while buyers can browse and filter through available products. Additionally, administrators can oversee the marketplace and filter through sellers.

Seller

• Account Creation: Sellers can create an account using their email to access the Marketplace.

  • A modal allows sellers to input their email, password, and password confirmation.
  • If the password and confirmation do not match, an error message is displayed.
  • If the user already exists, an alert displays the error.
  • Successful account creation closes the modal.

• Product Registration: Sellers can register products and assign prices for customers to view.

  • Products can be created with a name, SKU, quantity, and price. An error indicates any missing attributes.
  • Only authenticated users can upload products.

• Product Management: Sellers can view and manage all the products they have registered.

  • Each seller can only view products they have listed.
  • Access to this screen requires user authentication.

Buyer

• Product Search: Buyers can search for products to add to their shopping cart.

  • Products can be filtered by name, SKU, and/or price range.

  

Administrator

• Product Oversight: Administrators can view all products registered on the marketplace.
  • Products can be filtered by the seller.
  • Access to this screen requires user authentication.

Route Protection

The application ensures route protection through authentication. Only authenticated users can access certain features:

• Sellers can register and manage products only when logged in.
• Administrators can view and filter all products on the platform when logged in.

Route protection is implemented using middleware that verifies user tokens and checks user roles to determine access levels.

Database Structure

The database consists of two main tables: vendedores and products.

vendedores

Column	Type	Description
id	SERIAL	Primary key
email	VARCHAR	Unique email address
password	VARCHAR	Hashed password for authentication
role	VARCHAR	User role (e.g., 'vendedor', 'admin')

products

Column	Type	Description
id	SERIAL	Primary key
name	VARCHAR	Name of the product
sku	VARCHAR	Unique SKU identifier
quantity	INT	Quantity available
price	DECIMAL	Price of the product
seller_id	INT	Foreign key referencing vendedores(id)

The vendedores table stores user information, while the products table stores product details associated with a seller.