PHPReaction Frontend Dashboard React

Summary

• What it is: An interface for the Dashboard project, allowing users to access various PHPReaction applications and services through a centralized dashboard interface.
• Goal: To offer a standardized Dashboard Interface (KISS - Keep It Simple, Stupid) that serves as a central hub linking to all other PHPReaction projects. The dashboard displays cards with icons and links to different applications based on user roles and permissions.
• Repository: GitHub repository — https://github.com/PHPCreation/phpreaction-frontend-dashboard-react 
• README (clone, run, repo Docker): README.md on default branch — https://github.com/PHPCreation/phpreaction-dashboard-login-react/blob/main/README.md 
• Primary users: Any PHPReaction users who may want to move between apps with ease.

Features

• Centralized Access: Links to all PHPReaction applications and services from a single interface.
• Role-Based Access: Cards are displayed based on user roles and permissions.
• Icon Integration: Uses icons from the icon project for easy customization.
• Multi-Section Organization: Organizes links into User, Software, Management, and Support sections.
• Dashboard Interface: Standardized basic dashboard interface that can display counts, sums, and other metrics for current month and before.

Deployed environments

Multi-environment setup (react-doc).

Related Links

APIs

• PHPR API Link :
  • dev : https://TENANT.cdk-ecs-dev.phpreaction.com/open-api/v3 
  • staging : https://TENANT.cdk-ecs-staging.phpreaction.com/open-api/v3 
  • production : https://TENANT.phpreaction.com/open-api/v3 

Dependencies & Dependents Apps

• Dependencies : Apps and services that dashboard uses
  • (None currently)
• Dependents : Apps and services that use dashboard
  • (None currently)

Integrations & dependencies

PHPR Bundles

• Authorization Bundle 
• Components Bundle 
• Config Bundle 
• CRUD Bundle 
• DynamoDB Bundle 
• Icons Bundle 
• Status Bundle 
• Utils Bundle 

Routes

Main Routes :

• /[locale]/ : Dashboard page - Main interface displaying cards with links to various PHPReaction applications and services. E.g. /en/ or /fr/
• /[locale]/tenant-not-found : Tenant not found page.

Status Routes :

• /[locale]/status/all : List all status page.
• /[locale]/status/api : APIs status page.
• /[locale]/status/cache : Cache status page.
• /[locale]/status/configs : Configs status page.
• /[locale]/status/user-token/check : Checks if user token exists and is valid.
• /[locale]/status/user-token/display : Displays user token information.
• /[locale]/status/user-token/expected : Displays expected user token information.

Related links

Repo

• Github : phpreaction-frontend-dashboard-react 
• Issues, Features & Backlog 

Docs

• Internal doc

• Client doc 

• Docker local setup

• API Calls

• User Roles

• [KVS] (TODO)

• [Environment Variables] (TODO)

Compliance

• Test Cases
• Security Checklist