ap7pd/event-management-frontend
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: Improve readme UI, use raw HTML for the table

Browse source
This commit is contained in:
Peter Vacho 2025-01-05 17:21:30 +01:00
parent 2a1d1f9ef6
commit 08e9e5c5a6
Signed by: school
GPG key ID: 8CFC3837052871B4
1 changed files with 115 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

146
README.md
View file

@ -40,34 +40,118 @@ Repository](https://git.itsdrike.com/ap7pd/event-management-backend).
Below is a showcase of key features and screens in the application: Below is a showcase of key features and screens in the application:
| ![API Unreachable](showcase/01_api_unreachable.png) | ![Login Screen](showcase/02_login.png) | ![Base URL Change](showcase/02_login_base_url_change.png) | <div style="padding: 20px; max-width: 1200px; margin: auto;">
| --------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------- | <table style="width: 100%; border-collapse: collapse; text-align: center;">
| Error screen, shown whenever the API becomes unreachable. | Login screen for user authentication. | Screen to update the API base URL, available from the login, register & API unreachable pages. | <thead>
<tr>
| ![Register Screen](showcase/03_register.png) | ![Month View](showcase/04_month_view.png) | ![Day View](showcase/05_day_view.png) | <th colspan="3" style="font-size: 24px; padding: 10px;">Showcase</th>
| -------------------------------------------- | ----------------------------------------- | ------------------------------------------------- | </tr>
| User registration screen. | Monthly calendar view to browse events. | Daily event view with event details for that day. | </thead>
<tbody>
| ![Edit Duration Event](showcase/06_duration_event_edit.png) | ![Edit Instant Event](showcase/07_instant_event_edit.png) | ![Invite User to Event](showcase/08_invite_user_to_event.png) | <tr>
| ----------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------- | <td>
| Edit screen for duration-based events. | Edit screen for instant events. | Interface for inviting users to an event. | <img src="showcase/01_api_unreachable.png" style="width: 250px; height: 140px;" alt="API Unreachable" />
<p>Error screen, shown whenever the API becomes unreachable.</p>
| ![Duration Event Details](showcase/09_duration_event_details.png) | ![Instant Event Details](showcase/10_instant_event_details.png) | ![Categories Overview](showcase/11_categories.png) | </td>
| ----------------------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------- | <td>
| Detailed view of a duration-based event. | Detailed view of an instant event. | List of event categories of the user. | <img src="showcase/02_login.png" style="width: 250px; height: 140px;" alt="Login Screen" />
<p>Login screen for user authentication.</p>
| ![Create New Category](showcase/12_new_category.png) | ![Updated Categories](showcase/13_categories_with_new.png) | ![Settings Screen](showcase/14_settings.png) | </td>
| ---------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- | <td>
| Form to create a new category. | Updated list with a newly added category. | Settings menu for app configuration. Only available when logged in. | <img src="showcase/02_login_base_url_change.png" style="width: 250px; height: 140px;" alt="Base URL Change" />
<p>Screen to update the API base URL, available from the login, register & API unreachable pages.</p>
| ![Notification: Invite](showcase/15_notification_invite_bob.png) | ![Invite Preview](showcase/16_invite_event_details_preview.png) | ![Notification: Invite Accepted](showcase/17_notification_invite_accepted_bob.png) | </td>
| ---------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | </tr>
| Notification about an (incomming) event invite. | Preview of the event from the invite. | Notification for the (incomming) invite after accepting (already marked read). | <tr>
<td>
| ![Day View with Invite](showcase/18_day_view_invited_event_bob.png) | ![Invited Event Details](showcase/19_invited_event_details_bob.png) | ![Notification Accepted John](showcase/20_notification_invite_accepted_john.png) | <img src="showcase/03_register.png" style="width: 250px; height: 140px;" alt="Register Screen" />
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | <p>User registration screen.</p>
| Day view showing the invited event. | Details of an event the user was invited to. | Notification about user having accepted an outgoing invite (from the invitor's account). | </td>
<td>
| ![Notifications Cleared](showcase/21_notifications_cleared.png) | <img src="showcase/04_month_view.png" style="width: 250px; height: 140px;" alt="Month View" />
| --------------------------------------------------------------- | <p>Monthly calendar view to browse events.</p>
| Screen showing cleared notifications. | </td>
<td>
<img src="showcase/05_day_view.png" style="width: 250px; height: 140px;" alt="Day View" />
<p>Daily event view with event details for that day.</p>
</td>
</tr>
<tr>
<td>
<img src="showcase/06_duration_event_edit.png" style="width: 250px; height: 140px;" alt="Edit Duration Event" />
<p>Edit screen for duration-based events.</p>
</td>
<td>
<img src="showcase/07_instant_event_edit.png" style="width: 250px; height: 140px;" alt="Edit Instant Event" />
<p>Edit screen for instant events.</p>
</td>
<td>
<img src="showcase/08_invite_user_to_event.png" style="width: 250px; height: 140px;" alt="Invite User to Event" />
<p>Interface for inviting users to an event.</p>
</td>
</tr>
<tr>
<td>
<img src="showcase/09_duration_event_details.png" style="width: 250px; height: 140px;" alt="Duration Event Details" />
<p>Detailed view of a duration-based event.</p>
</td>
<td>
<img src="showcase/10_instant_event_details.png" style="width: 250px; height: 140px;" alt="Instant Event Details" />
<p>Detailed view of an instant event.</p>
</td>
<td>
<img src="showcase/11_categories.png" style="width: 250px; height: 140px;" alt="Categories Overview" />
<p>List of event categories of the user.</p>
</td>
</tr>
<tr>
<td>
<img src="showcase/12_new_category.png" style="width: 250px; height: 140px;" alt="Create New Category" />
<p>Form to create a new category.</p>
</td>
<td>
<img src="showcase/13_categories_with_new.png" style="width: 250px; height: 140px;" alt="Updated Categories" />
<p>Updated list with a newly added category.</p>
</td>
<td>
<img src="showcase/14_settings.png" style="width: 250px; height: 140px;" alt="Settings Screen" />
<p>Settings menu for app configuration. Only available when logged in.</p>
</td>
</tr>
<tr>
<td>
<img src="showcase/15_notification_invite_bob.png" style="width: 250px; height: 140px;" alt="Notification: Invite" />
<p>Notification about an incoming event invite.</p>
</td>
<td>
<img src="showcase/16_invite_event_details_preview.png" style="width: 250px; height: 140px;" alt="Invite Preview" />
<p>Preview of the event from the invite.</p>
</td>
<td>
<img src="showcase/17_notification_invite_accepted_bob.png" style="width: 250px; height: 140px;" alt="Notification: Invite Accepted" />
<p>Notification for the incoming invite after accepting (already marked read).</p>
</td>
</tr>
<tr>
<td>
<img src="showcase/18_day_view_invited_event_bob.png" style="width: 250px; height: 140px;" alt="Day View with Invite" />
<p>Day view showing the invited event.</p>
</td>
<td>
<img src="showcase/19_invited_event_details_bob.png" style="width: 250px; height: 140px;" alt="Invited Event Details" />
<p>Details of an event the user was invited to.</p>
</td>
<td>
<img src="showcase/20_notification_invite_accepted_john.png" style="width: 250px; height: 140px;" alt="Notification Accepted John" />
<p>Notification about a user having accepted an outgoing invite (from the inviter's account).</p>
</td>
</tr>
<tr>
<td colspan="3">
<img src="showcase/21_notifications_cleared.png" style="width: 250px; height: 140px;" alt="Notifications Cleared" />
<p>Screen showing cleared notifications.</p>
</td>
</tr>
</tbody>
</table>
</div>