README.md

Hot Sauce Inventory

Hot Sauce Inventory Management
Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Dependencies
   • Prerequisites
2. Usage
3. Contact

Getting Started

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

Dependencies

• MongoDB
• NodeJS
• NoDemon

Prerequisites

1. Clone the repo

   git clone https://github.com/franciscarriere/hotsauce-inventory.git

2. Run NPM install for the server component

• npm

  cd app/
  npm install

2. Run NPM install for the client component

• npm

  cd app/src/client
  npm install

Local Development

During development, ensure your computer's host file has been edited to point volamtarpeppers.wrclan.ca to 127.0.0.1

To start the server for a dev environment, use the provided startup shell script.

• shell

  cd app/
  sh startup-dev.sh

Usage

To start the server, use the provided startup shell script.

• shell

  cd app/
  sh startup.sh

Contact

Francis Carriere - @FCArchon - [email protected]

https://github.com/franciscarriere/hotsauce-inventory