feat: #403 add documentation about frontend customization (#439)

* feat: #403 add documentation about frontend customization

* address comments

* address comments

* address comments

* fix prettier

Frontend_customization.md

@@ -0,0 +1,28 @@
+<!--
+SPDX-FileCopyrightText: 2024 PNED G.I.E.
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Frontend Customization Documentation
+
+## Environment Variables
+
+| Variable Name                | Explanation                                              | Additional Notes                                                 |
+| ---------------------------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
+| NEXT_PUBLIC_DDS_URL          | URL for the Data Discovery Service API                   | Ensure this points to the correct environment (dev/staging/prod) |
+| NEXT_PUBLIC_DAAM_URL         | URL for the Data Access and Authorization Management API | Ensure this points to the correct environment (dev/staging/prod) |
+| NEXTAUTH_URL                 | The base URL of your application                         | Important for authentication callbacks                           |
+| NEXTAUTH_SECRET              | Secret used to encrypt JWT tokens                        | Should be a long, random string. Rotate regularly for security   |
+| KEYCLOAK_CLIENT_ID           | Client ID for Keycloak authentication                    | Obtained from your Keycloak admin console                        |
+| KEYCLOAK_CLIENT_SECRET       | Client secret for Keycloak authentication                | Obtained from your Keycloak admin console. Keep this secret!     |
+| KEYCLOAK_ISSUER_URL          | URL of the Keycloak realm                                | Ensure this points to the correct realm                          |
+| END_SESSION_URL              | URL for ending the user's session                        | Used for logout functionality                                    |
+| REFRESH_TOKEN_URL            | URL for refreshing authentication tokens                 | Ensures long-lived sessions                                      |
+| CSP_HEADER                   | Content Security Policy header                           | Defines allowed sources for various resource types               |
+| NEXT_PUBLIC_SITE_TITLE       | Title of the site                                        | Displayed in browser tab and potentially in the header           |
+| NEXT_PUBLIC_SITE_DESCRIPTION | Brief description of the site                            | Used for SEO and potentially displayed on the site               |
+| NEXT*PUBLIC_COLOR*\*         | Various color configurations                             | Used to customize the site's color scheme                        |
+| NEXT*PUBLIC_SELECTED_FONT*\* | Font family selections                                   | Defines the typography for the site                              |
+| NEXT_PUBLIC_FOOTER_TEXT      | Text displayed in the footer                             | Typically contains copyright or funding information              |
+| NEXT*PUBLIC*\*\_URL          | Various social media and contact URLs                    | Used in the footer for external links                            |

README.md

@@ -67,6 +67,10 @@ TODO
 
 To get more help on Next JS, go check out the [Next JS API Reference](https://nextjs.org/docs/pages/api-reference) page.
 
+## Frontend Customization
+
+For detailed information on how to customize the GDI User Portal Front-end, including environment variables and additional customization options, please refer to the [Frontend Customization Documentation](Frontend_customization.md).
+
 ## License
 
 - All original source code is licensed under [Apache-2.0](./LICENSES/Apache-2.0.txt).

package.json

@@ -43,7 +43,6 @@
     "react-dom": "^18",
     "react-markdown": "^9.0.1",
     "react-phone-number-input": "^3.4.3",
-    "rehype-sanitize": "^6.0.0",
     "rehype-slug": "^6.0.0",
     "remark-gfm": "^4.0.0",
     "sharp": "^0.33.2",