|
|
@@ -1,10 +1,32 @@
|
|
|
# Subline Inventory Management
|
|
|
|
|
|
+## Introduction
|
|
|
Subline Inventory Management is a system for companies to track, update and manage their
|
|
|
inventory in real time. It is also a tool for gathering and analyzing data on inventory
|
|
|
in order to better manage future costs and reduce food waste for restaurants.
|
|
|
|
|
|
-# Getting Started
|
|
|
+The project is a hybrid single page app. After log in, users are given a single page app for interacting with the platform. Everything other than that (landing page, log in, help, etc.) is a more traditional website.
|
|
|
+
|
|
|
+## Technologies
|
|
|
+* HTML (ejs)
|
|
|
+* CSS
|
|
|
+* Nodejs
|
|
|
+* Javascript
|
|
|
+* MongoDB
|
|
|
+
|
|
|
+### NPM packages
|
|
|
+* axios
|
|
|
+* bcryptjs
|
|
|
+* compression
|
|
|
+* cookie-session
|
|
|
+* ejs
|
|
|
+* express
|
|
|
+* mailgun-js
|
|
|
+* mongoose
|
|
|
+* browserify (dev)
|
|
|
+* watchify (dev)
|
|
|
+
|
|
|
+## Setup
|
|
|
|
|
|
1. Install MongoDB
|
|
|
https://docs.mongodb.com/manual/installation/
|
|
|
@@ -20,8 +42,10 @@ in order to better manage future costs and reduce food waste for restaurants.
|
|
|
5. $ npm install -g nodemon (only if you are developing or adding code)
|
|
|
|
|
|
6. Create two environment variables:
|
|
|
- export PORT="8080"
|
|
|
- export SUBLINE="mongodb://localhost/InventoryManagement"
|
|
|
+ PORT="8080"
|
|
|
+ SUBLINE_DB="mongodb://localhost/InventoryManagement"
|
|
|
+ SITE="localhost:8080"
|
|
|
+ NODE_ENV="development
|
|
|
|
|
|
Mac/Linux Instructions:
|
|
|
1. Open '.bashrc' or .bash_profile' from the home directory
|
|
|
@@ -37,4 +61,4 @@ in order to better manage future costs and reduce food waste for restaurants.
|
|
|
7. $ nodemon app.js (if developing)
|
|
|
$ node app.js (to view)
|
|
|
|
|
|
-8. Open a browser and go to 'localhost:8000'
|
|
|
+8. Open a browser and go to 'localhost:8080'
|