Merge branch 'master' of github.com:bluewave-labs/bluewave-uptime

docs/quickstart.md

@@ -4,14 +4,14 @@ icon: sign-posts-wrench
 
 # Installing Uptime Manager
 
-
-
 ## Quickstart for users (quick method) <a href="#user-quickstart" id="user-quickstart"></a>
 
 1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/blob/develop/Docker/dist/docker-compose.yaml)
 2. Run `docker compose up` to start the application
 3. Now the application is running at `http://localhost`
 
+---
+
 ## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
 
 {% hint style="info" %}
@@ -26,42 +26,46 @@ Make sure you change the directory to the specified directories, as paths in com
 ### Setting up Docker images
 
 3. Change directory to the `Docker/dev` directory
-4. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
-5. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
+4. Build the docker images by running the `build_images.sh` script
+5. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
+6. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
 
 ### Server setup
 
 6. CD to `Server` directory, and run `npm install`
-7. While in `Server` directory, create a `.env` file with the required environmental variables
+7. While in `Server` directory, create a `.env` file with the [required environmental variables](#env-vars-server)
 8. While in the `Server` directory, run `npm run dev`
 
 ### Client setup
 
 9. CD to `Client` directory `run npm install`
-10. While in the `Client` directory, create a `.env` file with the required environmental variables
-11. While in the `Client` cirectory run `npm run dev`
+10. While in the `Client` directory, create a `.env` file with the [required environmental variables](#env-vars-client)
+11. While in the `Client` directory run `npm run dev`
 
 ### Access the application
 
 12. Client is now running at `localhost:5173`
 13. Server is now running at `localhost:5000`
 
+---
+
 ## Manual installation <a href="#manual-install" id="manual-install"></a>
 
 ### Client installation <a href="#install-client" id="install-client"></a>
 
 1. Change directory to the `Client` directory
 2. Install all dependencies by running `npm install`
+3. Add a `.env` file to the `Client` directory with the following options:
 
 #### Environment variables <a href="#env-vars-client" id="env-vars-client"></a>
 
-| ENV Variable Name         | Required/Optional | Type      | Description        | Accepted Values                    |
-| ------------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
-| VITE\_APP\_API\_BASE\_URL | Required          | `string`  | Base URL of server | {host}/api/v1                      |
-| VITE\_APP\_LOG\_LEVEL     | Optional          | `string`  | Log level          | `"none"`\|`"error"` \| `"warn"` \| |
-| VITE\_APP\_DEMO           | Optional          | `boolean` | Demo server or not | `true`\|`false` \|                 |
+| ENV Variable Name     | Required/Optional | Type      | Description        | Accepted Values                    |
+| --------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
+| VITE_APP_API_BASE_URL | Required          | `string`  | Base URL of server | {host}/api/v1                      |
+| VITE_APP_LOG_LEVEL    | Optional          | `string`  | Log level          | `"none"`\|`"error"` \| `"warn"` \| |
+| VITE_APP_DEMO         | Optional          | `boolean` | Demo server or not | `true`\|`false` \|                 |
 
-#### Starting the development server <a href="#start-client" id="start-client"></a>
+#### Starting the Client development server <a href="#start-client" id="start-client"></a>
 
 1. Run `npm run dev` to start the development server.
 
@@ -69,6 +73,7 @@ Make sure you change the directory to the specified directories, as paths in com
 
 1. Change the directory to the `Server` directory
 2. Install all dependencies by running `npm install`
+3. Add a `.env` file to the `Server` directory with the following options:
 
 #### Environment variables <a href="#env-vars-server" id="env-vars-server"></a>
 
@@ -76,7 +81,7 @@ Configure the server with the following environmental variables:
 
 <table><thead><tr><th width="239">ENV Variable Name</th><th width="149">Required/Optional</th><th width="116">Type</th><th>Description</th><th>Accepted Values</th></tr></thead><tbody><tr><td>CLIENT_HOST</td><td>Required</td><td><code>string</code></td><td>Frontend Host</td><td></td></tr><tr><td>JWT_SECRET</td><td>Required</td><td><code>string</code></td><td>JWT secret</td><td></td></tr><tr><td>DB_TYPE</td><td>Optional</td><td><code>string</code></td><td>Specify DB to use</td><td><code>MongoDB | FakeDB</code></td></tr><tr><td>DB_CONNECTION_STRING</td><td>Required</td><td><code>string</code></td><td>Specifies URL for MongoDB Database</td><td></td></tr><tr><td>PORT</td><td>Optional</td><td><code>integer</code></td><td>Specifies Port for Server</td><td></td></tr><tr><td>LOGIN_PAGE_URL</td><td>Required</td><td><code>string</code></td><td>Login url to be used in emailing service</td><td></td></tr><tr><td>REDIS_HOST</td><td>Required</td><td><code>string</code></td><td>Host address for Redis database</td><td></td></tr><tr><td>REDIS_PORT</td><td>Required</td><td><code>integer</code></td><td>Port for Redis database</td><td></td></tr><tr><td>TOKEN_TTL</td><td>Optional</td><td><code>string</code></td><td>Time for token to live</td><td>In vercel/ms format https://github.com/vercel/ms</td></tr><tr><td>PAGESPEED_API_KEY</td><td>Optional</td><td><code>string</code></td><td>API Key for PageSpeed requests</td><td></td></tr><tr><td>SYSTEM_EMAIL_HOST</td><td>Required</td><td><code>string</code></td><td>Host to send System Emails From</td><td></td></tr><tr><td>SYSTEM_EMAIL_PORT</td><td>Required</td><td><code>number</code></td><td>Port for System Email Host</td><td></td></tr><tr><td>SYSTEM_EMAIL_ADDRESS</td><td>Required</td><td><code>string</code></td><td>System Email Address</td><td></td></tr><tr><td>SYSTEM_EMAIL_PASSWORD</td><td>Required</td><td><code>string</code></td><td>System Email Password</td><td></td></tr></tbody></table>
 
-***
+---
 
 #### Databases <a href="#databases" id="databases"></a>
 
@@ -121,17 +126,17 @@ From the `Docker` directory run
 
 </details>
 
-***
+---
 
 #### Starting the development derver <a href="#start-server" id="start-server"></a>
 
-* run `npm run dev` to start the development server
+- run `npm run dev` to start the development server
 
 or,
 
-* run `node index.js` to start server
+- run `node index.js` to start server
 
-***
+---
 
 ### API documentation <a href="#api-documentation" id="api-documentation"></a>
 

docs/users-guide/quickstart.md

@@ -4,14 +4,14 @@ icon: sign-posts-wrench
 
 # Installing Uptime Manager
 
-
-
 ## Quickstart for users (quick method) <a href="#user-quickstart" id="user-quickstart"></a>
 
 1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/blob/develop/Docker/dist/docker-compose.yaml)
 2. Run `docker compose up` to start the application
 3. Now the application is running at `http://localhost`
 
+---
+
 ## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
 
 {% hint style="info" %}
@@ -26,42 +26,46 @@ Make sure you change the directory to the specified directories, as paths in com
 ### Setting up Docker images
 
 3. Change directory to the `Docker/dev` directory
-4. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
-5. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
+4. Build the docker images by running the `build_images.sh` script
+5. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
+6. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
 
 ### Server setup
 
 6. CD to `Server` directory, and run `npm install`
-7. While in `Server` directory, create a `.env` file with the required environmental variables
+7. While in `Server` directory, create a `.env` file with the [required environmental variables](#env-vars-server)
 8. While in the `Server` directory, run `npm run dev`
 
 ### Client setup
 
 9. CD to `Client` directory `run npm install`
-10. While in the `Client` directory, create a `.env` file with the required environmental variables
-11. While in the `Client` cirectory run `npm run dev`
+10. While in the `Client` directory, create a `.env` file with the [required environmental variables](#env-vars-client)
+11. While in the `Client` directory run `npm run dev`
 
 ### Access the application
 
 12. Client is now running at `localhost:5173`
 13. Server is now running at `localhost:5000`
 
+---
+
 ## Manual installation <a href="#manual-install" id="manual-install"></a>
 
 ### Client installation <a href="#install-client" id="install-client"></a>
 
 1. Change directory to the `Client` directory
 2. Install all dependencies by running `npm install`
+3. Add a `.env` file to the `Client` directory with the following options:
 
 #### Environment variables <a href="#env-vars-client" id="env-vars-client"></a>
 
-| ENV Variable Name         | Required/Optional | Type      | Description        | Accepted Values                    |
-| ------------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
-| VITE\_APP\_API\_BASE\_URL | Required          | `string`  | Base URL of server | {host}/api/v1                      |
-| VITE\_APP\_LOG\_LEVEL     | Optional          | `string`  | Log level          | `"none"`\|`"error"` \| `"warn"` \| |
-| VITE\_APP\_DEMO           | Optional          | `boolean` | Demo server or not | `true`\|`false` \|                 |
+| ENV Variable Name     | Required/Optional | Type      | Description        | Accepted Values                    |
+| --------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
+| VITE_APP_API_BASE_URL | Required          | `string`  | Base URL of server | {host}/api/v1                      |
+| VITE_APP_LOG_LEVEL    | Optional          | `string`  | Log level          | `"none"`\|`"error"` \| `"warn"` \| |
+| VITE_APP_DEMO         | Optional          | `boolean` | Demo server or not | `true`\|`false` \|                 |
 
-#### Starting the development server <a href="#start-client" id="start-client"></a>
+#### Starting the Client development server <a href="#start-client" id="start-client"></a>
 
 1. Run `npm run dev` to start the development server.
 
@@ -69,6 +73,7 @@ Make sure you change the directory to the specified directories, as paths in com
 
 1. Change the directory to the `Server` directory
 2. Install all dependencies by running `npm install`
+3. Add a `.env` file to the `Server` directory with the following options:
 
 #### Environment variables <a href="#env-vars-server" id="env-vars-server"></a>
 
@@ -76,7 +81,7 @@ Configure the server with the following environmental variables:
 
 <table><thead><tr><th width="239">ENV Variable Name</th><th width="149">Required/Optional</th><th width="116">Type</th><th>Description</th><th>Accepted Values</th></tr></thead><tbody><tr><td>CLIENT_HOST</td><td>Required</td><td><code>string</code></td><td>Frontend Host</td><td></td></tr><tr><td>JWT_SECRET</td><td>Required</td><td><code>string</code></td><td>JWT secret</td><td></td></tr><tr><td>DB_TYPE</td><td>Optional</td><td><code>string</code></td><td>Specify DB to use</td><td><code>MongoDB | FakeDB</code></td></tr><tr><td>DB_CONNECTION_STRING</td><td>Required</td><td><code>string</code></td><td>Specifies URL for MongoDB Database</td><td></td></tr><tr><td>PORT</td><td>Optional</td><td><code>integer</code></td><td>Specifies Port for Server</td><td></td></tr><tr><td>LOGIN_PAGE_URL</td><td>Required</td><td><code>string</code></td><td>Login url to be used in emailing service</td><td></td></tr><tr><td>REDIS_HOST</td><td>Required</td><td><code>string</code></td><td>Host address for Redis database</td><td></td></tr><tr><td>REDIS_PORT</td><td>Required</td><td><code>integer</code></td><td>Port for Redis database</td><td></td></tr><tr><td>TOKEN_TTL</td><td>Optional</td><td><code>string</code></td><td>Time for token to live</td><td>In vercel/ms format https://github.com/vercel/ms</td></tr><tr><td>PAGESPEED_API_KEY</td><td>Optional</td><td><code>string</code></td><td>API Key for PageSpeed requests</td><td></td></tr><tr><td>SYSTEM_EMAIL_HOST</td><td>Required</td><td><code>string</code></td><td>Host to send System Emails From</td><td></td></tr><tr><td>SYSTEM_EMAIL_PORT</td><td>Required</td><td><code>number</code></td><td>Port for System Email Host</td><td></td></tr><tr><td>SYSTEM_EMAIL_ADDRESS</td><td>Required</td><td><code>string</code></td><td>System Email Address</td><td></td></tr><tr><td>SYSTEM_EMAIL_PASSWORD</td><td>Required</td><td><code>string</code></td><td>System Email Password</td><td></td></tr></tbody></table>
 
-***
+---
 
 #### Databases <a href="#databases" id="databases"></a>
 
@@ -121,17 +126,17 @@ From the `Docker` directory run
 
 </details>
 
-***
+---
 
 #### Starting the development derver <a href="#start-server" id="start-server"></a>
 
-* run `npm run dev` to start the development server
+- run `npm run dev` to start the development server
 
 or,
 
-* run `node index.js` to start server
+- run `node index.js` to start server
 
-***
+---
 
 ### API documentation <a href="#api-documentation" id="api-documentation"></a>