Merge branch 'develop' into feat/fe/infrastructure-details-connect-to-BE

guides/users-guide/quickstart.md

@@ -6,7 +6,7 @@ icon: sign-posts-wrench
 
 ## 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)
+1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/raw/refs/heads/master/Docker/dist/docker-compose.yaml)
 2. Run `docker compose up` to start the application
 3. Now the application is running at `http://localhost`
 
@@ -96,6 +96,13 @@ Make sure you change the directory to the specified directories, as paths in com
 | VITE_APP_LOG_LEVEL    | Optional          | `string`  | Log level          | `"none"`\|`"error"` \| `"warn"` \| |
 | VITE_APP_DEMO         | Optional          | `boolean` | Demo server or not | `true`\|`false` \|                 |
 
+Sample ENV file:
+
+```
+VITE_APP_API_BASE_URL="http://localhost:5000/api/v1"
+VITE_APP_LOG_LEVEL="debug"
+```
+
 #### Starting the Client development server <a href="#start-client" id="start-client"></a>
 
 1. Run `npm run dev` to start the development server.
@@ -112,6 +119,25 @@ 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>REFRESH_TOKEN_SECRET</td><td>Required</td><td><code>string</code></td><td>Refresh 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>REFRESH_TOKEN_TTL</td><td>Optional</td><td><code>string</code></td><td>Time for refresh token to live</td><td></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>
 
+Sample env file
+
+```
+CLIENT_HOST="http://localhost:5173"
+JWT_SECRET="my_secret"
+DB_TYPE="MongoDB"
+DB_CONNECTION_STRING="mongodb://localhost:27017/uptime_db"
+REDIS_HOST="127.0.0.1"
+REDIS_PORT=6379
+TOKEN_TTL="99d"
+PAGESPEED_API_KEY=<api_key>
+SYSTEM_EMAIL_HOST="smtp.gmail.com"
+SYSTEM_EMAIL_PORT=465
+SYSTEM_EMAIL_ADDRESS=<email_address>
+SYSTEM_EMAIL_PASSWORD=<password>
+REFRESH_TOKEN_SECRET="my_refresh"
+REFRESH_TOKEN_TTL="99d"
+```
+
 ---
 
 #### Databases <a href="#databases" id="databases"></a>