[ENH] Added NB_QUERY_PATH env var to configure path variable (#227)

* Added `NB_QUERY_PATH` env var to configure path variable * Renamed `NB_QUERY_PATH` to `NB_QUERY_URL_PATH` * Added `NB_QUERY_URL_PATH` to the README.md
neurobagel · Aug 2, 2024 · d73211c · d73211c
1 parent 36f8231
commit d73211c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -47,12 +47,13 @@ but before proceeding with either you need to set the environment variables.
 
 ### Mandatory configuration
 
-| Environment variable | Type    | Required                               | Default value if not set | Example                                                 |
-| -------------------- | ------- | -------------------------------------- | ------------------------ | ------------------------------------------------------- |
-| NB_API_QUERY_URL     | string  | Yes                                    | -                        | https://federate.neurobagel.org/                        |
-| NB_IS_FEDERATION_API | boolean | No                                     | true                     | true                                                    |
-| NB_ENABLE_AUTH       | boolean | no                                     | false                    | false                                                   |
-| NB_QUERY_CLIENT_ID   | string  | Yes (if NB_ENABLE_AUTH is set to true) | -                        | 46923719231972-dhsahgasl3123.apps.googleusercontent.com |
+| Environment variable   | Type    | Required                                 | Default value if not set | Example                                                   |
+| ---------------------- | ------- | ---------------------------------------- | ------------------------ | --------------------------------------------------------- |
+| `NB_API_QUERY_URL`     | string  | Yes                                      | -                        | `https://federate.neurobagel.org/`                        |
+| `NB_IS_FEDERATION_API` | boolean | No                                       | `true`                   | `true`                                                    |
+| `NB_QUERY_URL_PATH`    | string  | No                                       | `/`                      | `/query/`                                                 |
+| `NB_ENABLE_AUTH`       | boolean | No                                       | `false`                  | `false`                                                   |
+| `NB_QUERY_CLIENT_ID`   | string  | Yes (if `NB_ENABLE_AUTH` is set to true) | -                        | `46923719231972-dhsahgasl3123.apps.googleusercontent.com` |
 
 #### `NB_API_QUERY_URL`
 
@@ -62,6 +63,10 @@ You'll need to set the `NB_API_QUERY_URL` environment variable required to run t
 
 If the API you'd like to send queries to is not a [federation api](https://neurobagel.org/federate/), you need to set the `NB_IS_FEDERATION_API` to `false` as it is `true` by default.
 
+#### `NB_QUERY_URL_PATH`
+
+If you are using a custom configuration where the query tool is accessible via a path other than the root (`/`), you need to set the `NB_QUERY_URL_PATH` to your custom path. This ensures that the query tool is correctly rendered and accessible at the specified URL
+
 #### `NB_ENABLE_AUTH`
 
 If the API you'd like to send queries to requires authentication, you need to set `NB_ENABLE_AUTH` to `true` as it is `false` by default. This will enable authentication flow of the app.

diff --git a/src/main.tsx b/src/main.tsx
@@ -4,12 +4,12 @@ import { createBrowserRouter, RouterProvider } from 'react-router-dom';
 import { StyledEngineProvider } from '@mui/material/styles';
 import { GoogleOAuthProvider } from '@react-oauth/google';
 import App from './App';
-import { enableAuth, clientID } from './utils/constants';
+import { queryURLPath, enableAuth, clientID } from './utils/constants';
 import './index.css';
 
 const router = createBrowserRouter([
   {
-    path: '/',
+    path: queryURLPath,
     element: <App />,
   },
 ]);

diff --git a/src/utils/constants.ts b/src/utils/constants.ts
@@ -14,6 +14,8 @@ export const isFederationAPI: boolean =
     ? true
     : import.meta.env.NB_IS_FEDERATION_API.toLowerCase() === 'true';
 
+export const queryURLPath: string = import.meta.env.NB_QUERY_URL_PATH ?? '/';
+
 export const enableAuth: boolean =
   import.meta.env.NB_ENABLE_AUTH === undefined
     ? false