Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.17 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.17 KB

E-Commerce Platform README

Welcome to our E-Commerce Platform project! This platform provides a seamless shopping experience for users, allowing them to browse and purchase products as buyers and set up seller accounts to upload and manage their products.

Getting Started

To run the project locally, you'll need to set up both the backend and frontend environments.

Prerequisites

  • Node.js installed on your machine
  • npm (Node Package Manager) installed
  • PostgreSQL database installed

Backend Setup

  1. Navigate to the backend directory.
  2. Install dependencies by running npm install.
  3. Start the backend server by running node server.js.

Frontend Setup

  1. Navigate to the frontend directory.
  2. Install dependencies by running npm install.
  3. Start the frontend development server by running npm run dev.

Project Overview

This E-Commerce Platform utilizes OAuth 2.0 authentication for user login, ensuring secure access to the platform. Users can register as both buyers and sellers, providing them with distinct functionalities and experiences.

Buyer Features

  • Browse through a wide range of products listed on the platform.
  • Add desired items to the shopping cart for later purchase.
  • Proceed to checkout securely and complete the purchase transaction.

Seller Features

  • Set up a seller account with OAuth 2.0 authentication.
  • Upload product listings, including images, descriptions, and pricing.
  • Manage inventory and product details conveniently through the seller dashboard.

Technologies Used

  • Backend: Node.js, Express.js, Sequelize ORM, PostgreSQL
  • Frontend: React.js, TypeScript, React Router, OAuth 2.0 authentication

Contributing

We welcome contributions from the community to improve and enhance the functionality of our platform. If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure the codebase is properly tested.
  4. Submit a pull request detailing your changes.

Support

If you encounter any issues or have questions about the project, feel free to reach out to our team for support. I'm here to help!