// README Project - CATWALK

Table of Contents

1. Description
2. Installation
3. Usage
4. Contributors
5. Contributing
6. License

Description

Catwalk is a front-end development project that focuses on creating an e-commerce application using ReactJS framework.

This single page web application consists of four interactive widgets: product overview, related products, questions and answers, and ratings and reviews. Users have the ability to post questions, answers, and reviews about the available products.

Widget Overview:

1. Product Overview - The product overview appears at the top of the page and serves as the entry point for users.
2. Related Products - Allows users to see related products and build an outfit of preferred products.
3. Questions and Answers - Allows users to search questions, ask questions, and post answers.
4. Ratings and Reviews - This widget summarizes how customers feel about the selected product. The user can see how many people have given the product a rating of 1 to 5 stars, as well as what people have written about the product. Reviews can be sorted in ascending or descending order on various characteristics such as date written, review length, rating given, and review helpfulness.

Installation

Installation

• Clone the repository to your local machine and use npm install.
• Open the repo folder in preferred code editor.
• Add .env file and assign an API key/github token to REACT_APP_API_KEY variable Run:

npm install
npm run react-dev
npm start

• Open http://localhost:3000 in browser

Usage

Project Catwalk is an e-commerce web application for buying various types of fashion products. This application allows users to connect with their inner beauty, and communicate with like-minded individuals about current fashion trends. Users can view products and build outfits. Users can also ask questions about particular products and post answers. Users provide others with fashion insights by leaving reviews for any and all products.

Contributors

Evan Mastro, Matt Dowell, John Duval, and Wilson Wong

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT