From 791983941e8a174398425c00420fc9581e89c089 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Sun, 5 May 2024 11:09:19 -0700 Subject: [PATCH] Added basic installation and startup info to readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index eec3da6a1..bb9b33300 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # bluewave-uptime + BlueWave uptime monitoring application + +## Getting Started + +- Clone this repository to your local machine + +--- + +### Client + +#### Installation + +1. Change directory to the `Client` directory +2. Install all dependencies by running `npm install` + +#### Starting Development Server + +1. Run `npm run dev` to start the development server. + +--- + +### Server + +#### Installation + +1. Change directory to the `Server` directory +2. Install all depencies by running `npm install` + +#### Starting the Development Server + +1. run `npm run dev` to start the development server