Skip to content

Latest commit

 

History

History
179 lines (128 loc) · 4.92 KB

README.md

File metadata and controls

179 lines (128 loc) · 4.92 KB
Raw

Logo

Crwn Clothing

An e-commerce app for shopping clothes like hats, jackets, and sneakers for men and women. Built with React, TypeScript, Redux, Sagas, and Firebase.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgements

About The Project

Product Name Screen Shot

Crwn Clothing is an e-commerce app for shopping jackets, hats, sneakers, and many more for both men and women The app is built using React, TypeScript, Redux, Redux Sagas, and Firebase for storing data.

The app allows users to:

  • Browse and search for various clothing items.
  • Add items to their shopping cart.
  • Checkout and make purchases securely using Firebase.
  • View and manage their order history.

Built With

This app is built using the following technologies:

Getting Started

To get started with the project, you can either fork this repository or download it locally to your system.

To get a local copy up and running, follow these simple example steps.

Prerequisites

Make sure you have the latest version of NPM installed to avoid any errors:

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/stekatag/crwn-clothing.git
  2. Move into the project directory 
    cd crwn-clothing
  3. Install NPM packages 
    npm install
  4. Configure Firebase:
  • Go to Firebase and create a new project.
  • Obtain your Firebase configuration settings.
  • Replace the Firebase config in src/utils/firebase/firebase.utils.ts with your own config.
  1. Start the development server 
    npm run dev

Usage

  1. Create an account or login to the app. (not required)

  2. Browse through the available clothing items in the app.

  3. Add items to your shopping cart.

  4. Proceed to checkout page to make a demo purchase using Stripe.

Roadmap

See the open issues for a list of proposed features (and known issues).

Proposed features

  1. Implement a search feature for searching items by name.

  2. Saving the cart items in the database for logged in users.

  3. Allow users to filter products by categories, sizes, and prices.

  4. Implement a wish list feature for saving favorite items.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AwesomeNewFeature)
  3. Commit your Changes (git commit -m 'Add some AwesomeNewFeature')
  4. Push to the Branch (git push origin feature/AwesomeNewFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See license for more information.