ComfiableHomes E-commerce Project

You may click the heading above to visit the application

Getting Started

To start working on the project, follow these steps:

1. Fork repository to your local GitHub account.
2. Clone the forked repository to your local development environment.
3. Install the required dependencies by running npm install in the project directory.
4. Open the project in your preferred code editor.
5. Review the existing code in the src directory to understand the initial structure and components hierarchy.
6. Implement the ecommerce functionalities by modifying the necessary components.
7. Run the application using npm run dev
8. Commit you changes when significant changes are made, then push them to a branch in your forked repository.
9. Once you have completed the project goals, create a pull request to merge your changes into the main repositiory.

Technical Instruction

1. Fork this repo to your local GitHub account.
2. Create a new branch to complete all your work in.
3. Test your work with your preferred testing tool.
4. Create a Pull Request against your main branch when you are done and all tests are passing.

Project Overview

The goal of this project is to build a fully functional e-commerce website with the following major features:

• User authentication
• Products filters:
  • Filter by category
  • Filter by company
  • Filter by price
  • Filter by lowest and highest price
  • Filter by price range
• Payment integration (Paystack)

Product Setup

To get started with the project, follow these steps:

1. Clone the project repository to your local development environment.
2. Install the required dependencies by running npm install in the project directory.
3. Familarize yourself with the project structure.
4. Review the existing code files to understand the initail structure and component hierarchy.

Project Goals

1. Implement the ecommerce functionalities:

• Implement user authentication:

  • The user should be able to register
  • The user should be able to login
  • The user should be able to logout

• Implement products filtering:

  • Filtering by category
  • Filtering by company
  • Filtering by price
  • Filtering by lowest and highest price
  • Filtering by price range

• Payment integration (Paystack):

  • User should be able to make payment using Paystack payment methods

  2. Ensure code quality:

     • Write clean, well-structured, and maintainable codes; one of the ways which is maintaining modular programming.
     • Follow best practices and adhere to the React coding conventions.
     • Pay attention to performance.

  3. Code documentation:

     • Document your code by adding comments and explanatory notes where necessary.

  4. Use version control:

     • Use Git for version control. Commit you changes when important changes are made and push them to a branch in your forked repository.

  5. Create a PR:

     • Once you have completed the project goals, create a pull request to merge your changes into the main repository.
     • While at this, provide a clear description of the changes made and any relevent information for the code review.

Resources

Here are some resources that may be helpful during your work on this project:

• Vite Documentation - Official documentation for Vite, providing guides on how to install Vite application.

• React Documentation - Official documentation for React, providing detailed information on React concepts and usage.