Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 2.16 KB

README.md

File metadata and controls

68 lines (42 loc) · 2.16 KB
Raw

E-Commerce React SPA

This is a single page application for a theoretical E-commerce business that is looked to re-vamp their online presence. Data is retrieved from a black-box API - Atelier.

Authors

Screenshots

App Screenshot1

App Screenshot2

App Screenshot3

Installation

Clone repo down onto your local computer. Cd into the location where the repository is located. Once in the repo, run

  npm install

Once npm is installed, we must then build our webpack file -> bundle.js

  npm run build
  npm run watch

After the webpack file has been compiled -> open a server upon a locally hosted port by running

  npm start

This command will utilize nodemon. After running this command "listening on port x" * default port 3737 * should appear within the terminal. Navigate to the local-host port to open this application in a web browser.

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY <- Insert Github API token

Example:

API help

An example config file is located in /Client/src/env/example-config.js. Please create a new config.js file following the set-up in example-config.js

Acknowledgements

Feedback

If you have any feedback, please reach out to us at [email protected]