Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 4.29 KB

README.md

File metadata and controls

93 lines (59 loc) · 4.29 KB

NEED

NEED is your all-inclusive online marketplace built with the goal of answering to any and every need. Our motto is "You Need? We Got.", a testament to our dedication in providing a platform where you can find virtually anything, from little knick-knacks to the most essential doodads. Don't be surprised if you find a Thing-a-majig!

Technologies Used

  • React.js: for building user interface components
  • Material UI: for designing responsive user interfaces
  • Express.js: for handling server-side logic
  • Mongoose: for modeling application data
  • MongoDB: for data storage
  • DUMMYJSON API: A flexible and customizable API used for generating random JSON data. This tool provides simulated data, mimicking real-world patterns and structures, which is useful for testing and developing our application.
  • Stripe API: An API providing powerful and flexible tools for internet commerce. Stripe's software allows for highly customizable payment flow processes, supporting our online marketplace's need for secure transaction processing.

Getting Started

  1. Click here to start shopping.

  2. Take a look at my Trello Board.

AuthPage AuthPageDark

  1. To access NEED, you must first SignUp if its your first time visiting. Otherwise, enter credentials to sign up.

HomePage

  1. To start shopping, simply click Shop Now or click the logo on the Navigation Bar

Shop ShopDark

  1. Browse through our vast catalogue of products from the Shop. You can search for specific products, sort by categories, or load more items on the page.

Details DetailsDark

  1. Click on 'See More' product for more information.

Cart CartDark

  1. Add any products you wish to purchase to your cart.

Checkout CheckoutDark

  1. When you are done shopping, proceed to checkout. Complete the payment process to place your order.

Confirmation ConfirmationDark

  1. Look over your order confirmation and enjoy your items delivered right to your doorstep!

ICEBOX FEATURES

  • Implement counter over cart icon for better UX
  • Option to review Purchase History for each user
  • Option for users to creae and manage wishlist
  • Mutiple currency and language support for a global user base
  • Customer reviews, and option to add own rating

Contribution Guidelines

Thank you for considering contributing to our project! I appreciate any contributions that can improve the project, fix bugs, or add new features. Please follow the guidelines below for a smooth collaboration process.

Bug Reports and Feature Requests

If you encounter a bug or have a feature request, please open an issue on our GitHub repository. Provide detailed information about the problem or the requested feature, including steps to reproduce the issue if applicable.

Pull Requests

I welcome pull requests for bug fixes, improvements, or new features. To contribute code to the project, follow these steps:

  1. Fork the repository and create your branch from main.
  2. Ensure your code follows the project's coding conventions and style guide.
  3. Include tests to ensure the correctness of your changes.
  4. Make sure your code passes all existing tests.
  5. Write clear and concise commit messages.
  6. Submit a pull request to the main branch.

I will review your pull request promptly.

Code Style and Conventions

To maintain a consistent codebase, please adhere to the following code style and conventions:

  • Follow the styling for the project.
  • Use meaningful and descriptive variable and function names.
  • Write clear and concise comments

I appreciate your contributions in making this project better!