Skip to content

Latest commit

 

History

History
91 lines (73 loc) · 3.54 KB

README.md

File metadata and controls

91 lines (73 loc) · 3.54 KB
Raw

Maintainability Test Coverage Coverage Status CircleCI

Vercel Preview Deployment

Next JS

champs-ec-fe

Project Overview

The Champs-EC-FE (Champs E-Commerce Frontend) project is designed to create a robust and user-friendly frontend application for an e-commerce platform. It will offer a rich shopping experience by integrating with the backend e-commerce (champs-ec-be ) API to deliver real-time functionalities and data.

Project Goals

  • User Experience: Deliver a seamless and intuitive user experience.
  • Performance: Ensure high performance and responsiveness.
  • Maintainability: Develop clean, modular, and maintainable code.

Getting Started with project

  1. Clone the Repository:

git clone https://github.com/atlp-rwanda/champs-ec-fe.git
cd champs-ec-fe

  1. Install Dependencies:

    npm install

  1. Run the Development Server:

    npm run dev

  1. Build for Production:

    npm run build

  1. Run Tests:

    npm run test

Technologies Used

  • Frontend Framework: Next.js for building a dynamic and component-based UI.
  • State Management: Redux or Context API for managing application state.
  • Routing: Next js App Router for handling navigation within the application.
  • Styling: TailwindCSS for modern and maintainable styles.

Other Development Tools

  1. Version Control: Git and GitHub for version control and collaboration.

  2. Code Quality: ESLint and Prettier for maintaining code quality and consistency.

  3. CI/CD tools: for continuous integration and deployment.

Champs-ec-fe Features

User Authentication:

  • user login and registration processes.
  • update user profile
  • update user password
  • Password recovery options

Product Listings:

  • view all available products
  • search for specific products with various conditions
  • Detailed product page (view single product)
  • customer reviews

Shopping Cart:

  • Functionality to add, remove, and update product quantities.

Product Wishes:

  • Functionality to add, remove, and update product wish list.

Checkout Process:

  • Product payment with stirpe payment gateway

User Dashboard (Seller):

  • view orders and single order detail(selller)
  • add new products to seller collection
  • managing own products (view,edit,delete)
  • view client orders and update orders status
  • view client wishlist

User Dashboard (Admin):

  • managing user role (add, edit and delete a role)
  • grant role to a user
  • listing all users
  • Activating and Deactivating user for a certain reason
  • featuring products