Skip to content

Improve table formatting in README.md #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antonioalanxs merged 1 commit into from
Jul 12, 2025
Merged

Improve table formatting in README.md #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 43 additions & 39 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,22 +122,24 @@ Use the `build_and_push_image.sh` script to build and push your Docker images to

### Sample users

| **Role** | **Username** | **Password** |
|----------------|--------------|--------------|
| Administrator | 11223344C | root |
| Doctor | 87654321B | root |
| Patient | 12345678A | root |
| **Role** | **Username** | **Password** |
| :-----------: | :----------: | :----------: |
| Administrator | 11223344C | root |
| Doctor | 87654321B | root |
| Patient | 12345678A | root |


There are more users, but these are the most representative.

### User types

| User Type | Description |
|---------------|----------------------------------------------------------------------------------------------|
| Anonymous | Unregistered user in the application, with no access to most functionalities. |
| Patient | Registered user with permissions focused on functionalities intended for patients. |
| Doctor | Registered user with access to functionalities specific to the medical role. |
| Administrator | Registered user with full control over the platform and all its entities, with the widest and most complete set of permissions. |
| **User Type** | **Description** |
| :-----------: | :--------------------------------------------------------------------------------------------------: |
| Anonymous | Unregistered user in the application, with no access to most functionalities. |
| Patient | Registered user with permissions focused on functionalities intended for patients. |
| Doctor | Registered user with access to functionalities specific to the medical role. |
| Administrator | Registered user with full control over the platform and all its entities, with the most permissions. |



### Functional Requirements
Expand Down Expand Up @@ -197,35 +199,37 @@ There are more users, but these are the most representative.

### Non Functional Requirements

| **Non Functional Requirements** |
|---------------------------------------------------------------------|
| Support for Most Web Browsers |
| Responsive Design |
| Minimalist and User-Friendly Interface |
| Back Navigation on All Screens |
| Accessibility and Usability |
| Email Sending |
| Email Layout |
| Scalability |
| Availability |
| JWT Authentication |
| Automatic Session Renewal |
| Search and Pagination of All Resources |
| SQL Database |
| Data Export in Excel (.xlsx) or JSON Format |
| Security and Protection of Users’ Confidential Information |
| **Non Functional Requirements** |
| :--------------------------------------------------------: |
| Support for Most Web Browsers |
| Responsive Design |
| Minimalist and User-Friendly Interface |
| Back Navigation on All Screens |
| Accessibility and Usability |
| Email Sending |
| Email Layout |
| Scalability |
| Availability |
| JWT Authentication |
| Automatic Session Renewal |
| Search and Pagination of All Resources |
| SQL Database |
| Data Export in Excel (.xlsx) or JSON Format |
| Security and Protection of Users’ Confidential Information |



### Diagrams

| Category | URI |
|------------------------------------------|------------------------------------------------------------------------------------------|
| [NM1] - Anonymous Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-anonymous.png) |
| [NM2] - Patient Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-patient.png) |
| [NM3] - Doctor Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-doctor.png) |
| [NM4] - Administrator Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-admin.png) |
| [NM5] - Screen / Error Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-screens.png) |
| Architecture Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/architecture-diagram-v2.png) |
| E / R Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/er-diagram.png) |
| Database Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/database-diagram.png) |
| Real-Time Tracking of Patients Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/websockets-diagram.png) |
| **Category** | **URI** |
| :------------------------------------: | :-----------------------------------------------------------------------------------------------------: |
| NM1 - Anonymous Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-anonymous.png) |
| NM2 - Patient Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-patient.png) |
| NM3 - Doctor Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-doctor.png) |
| NM4 - Administrator Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-admin.png) |
| NM5 - Screen / Error Navigation Map | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/navmap-screens.png) |
| Architecture Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/architecture-diagram-v2.png) |
| E / R Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/er-diagram.png) |
| Database Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/database-diagram.png) |
| Real-Time Tracking of Patients Diagram | [↗️](https://github.com/antonioalanxs/FindMyPatient/blob/main/README-files/websockets-diagram.png) |