From b1d2a3912a51a87d2bd22832994e4196a08d4907 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Wed, 12 Jun 2024 11:04:11 -0700 Subject: [PATCH] Removed accidental Notification commit, updated readme with ENV vars for client --- Client/src/Components/Notifications/notify.js | 2 -- README.md | 34 +++++++++++++------ 2 files changed, 24 insertions(+), 12 deletions(-) delete mode 100644 Client/src/Components/Notifications/notify.js diff --git a/Client/src/Components/Notifications/notify.js b/Client/src/Components/Notifications/notify.js deleted file mode 100644 index 86be4a0ab..000000000 --- a/Client/src/Components/Notifications/notify.js +++ /dev/null @@ -1,2 +0,0 @@ -import { toast } from "react-toastify"; -export default (message) => toast(message); diff --git a/README.md b/README.md index 02890e230..bee12f083 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,14 @@ BlueWave uptime monitoring application - Clone this repository to your local machine 1. [Installation (Client)](#client) -2. [Installation (Server)](#server) -3. [Configuration(Server)](#config-server) - - [Environment](#environmental-variables) +2. [Configuration(Client)](#config-server) + - [Environment](#env-vars-client) +3. [Installation (Server)](#server) +4. [Configuration(Server)](#config-server) + - [Environment](#env-vars-server) - [Database](#databases) - [Docker Images](#docker-images) -4. [Endpoints](#endpoints) +5. [Endpoints](#endpoints) ###### Auth - POST [/api/v1/auth/register](#post-register) - POST [/api/v1/auth/login](#post-login) @@ -48,8 +50,8 @@ BlueWave uptime monitoring application - GET [/api/v1/alerts/{alertId}](#get-alert-alert-id) - POST [/api/v1/alerts/edit/{alertId}](#edit-alert) - POST [/api/v1/alerts/delete/{alertId}](#delete-alert) -5. [Error Handling](#error-handling) -6. [Contributors](#contributors) +6. [Error Handling](#error-handling) +7. [Contributors](#contributors) --- @@ -60,6 +62,18 @@ BlueWave uptime monitoring application 1. Change directory to the `Client` directory 2. Install all dependencies by running `npm install` +
+ +#### Configuration + +##### Environmental Variables + +| ENV Variable Name | Required/Optional | Type | Description | Accepted Values | +| --------------------- | ----------------- | -------- | ------------------ | --------------- | +| VITE_APP_API_BASE_URL | Required | `string` | Base URL of server | {host}/api/v1 | + +
+ #### Starting Development Server 1. Run `npm run dev` to start the development server. @@ -73,11 +87,11 @@ BlueWave uptime monitoring application 1. Change directory to the `Server` directory 2. Install all dependencies by running `npm install` ---- +
#### Configuration -##### Environmental Variables +##### Environmental Variables Configure the server with the following environmental variables: @@ -94,7 +108,7 @@ Configure the server with the following environmental variables: | REDIS_HOST | Required | `string` | Host address for Redis database | | | REDIS_PORT | Required | `integer` | Port for Redis database | | ---- +
##### Databases @@ -133,7 +147,7 @@ From the `Redis` folder run 2. Run the image: `docker run -d -p 6379:6379 -v $(pwd)/../redis/redis_data:/data --name uptime_redis uptime_redis` ---- +
#### Starting the Development Server