From c763db241329fce73f45e60a6c502b09881ce648 Mon Sep 17 00:00:00 2001 From: Cameron Maloney Date: Fri, 7 Jun 2024 05:11:09 -0700 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index f33f19d..ade5c1d 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,35 @@ and Project Description: SafeHaven is a company dedicated to optimizing storage management solutions for businesses. Our product scales easily, displays critical order insights, and is affordably priced. We offer a seamless inventory and order tracking system, suiting the needs of businesses in many industries. + +Note for grader: Sequence Diagrams are the two '.png' files in the root of the repo + +To run from the repository's root folder, install concurrently with: + +``` +npm install concurrently +``` + +Then simply run with: + +``` +npm start +``` + +or run the development mode with + +``` +npm run dev +``` + +Also, make sure to create a .env file in express-backend and add +`MONGODB_URI = "your_connection_string"` +and +`TOKEN_SECRET = 1234` + +Project Description: +SafeHaven is a company dedicated to optimizing storage management solutions for businesses. Our product scales easily, displays critical order insights, and is affordably priced. +We offer a seamless inventory and order tracking system, suiting the needs of businesses in many industries. + +CSC307 Safe Haven Demo Video: +https://youtu.be/EfknrWC4x_U