README.md

Reviews-module

                   

A reviews module to be used as part of our 'Glossier' product page implementation

Table of Contents

1. Related Projects
2. Requirements
3. Usage
4. Set-Up
5. Development By
6. License
7. Contributing

Related Projects

Proxy Server

• Andrew's Glossier Proxy - https://github.com/Dumpling-Squad/Andrew-s_Glossier_Proxy

Sub-Modules

• Navigation Bar - https://github.com/Dumpling-Squad/nav-bar
• Product Description - https://github.com/Dumpling-Squad/product-description
• Reviews Module - https://github.com/AndrewMore/reviews-module or https://github.com/Dumpling-Squad/reviews-module
• Suggested Items - https://github.com/Dumpling-Squad/suggested-items

Requirements

An nvmrc file is included if using nvm.

• Node 6.13.0

Usage

Must install, seed, and run sub-modules first.

Set-Up

From within the root directory:

yarn install
yarn run build
yarn start
mysql -u root -p <schema.sql
yarn run seed

Development by

Developer / Author: Andrew More

License

This work by Andrew More is licensed under a GNU General Public License Version 3.0.

Contributing

All contributions are welcome! Please take a moment to review guidelines Feature Requests | Issues