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 1fb412e0f3
Signed by: school
GPG key ID: 8CFC3837052871B4
1 changed files with 87 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

112
README.md
View file

@ -40,34 +40,96 @@ 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) | <style>
| --------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------- | table {
| 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. | width: 100%;
border-collapse: collapse;
text-align: center;
margin: auto;
table-layout: fixed; /* Ensures equal column widths */
}
| ![Register Screen](showcase/03_register.png) | ![Month View](showcase/04_month_view.png) | ![Day View](showcase/05_day_view.png) | th, td {
| -------------------------------------------- | ----------------------------------------- | ------------------------------------------------- | padding: 10px;
| User registration screen. | Monthly calendar view to browse events. | Daily event view with event details for that day. | }
| ![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) | details {
| ----------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------- | width: 100%; /* Matches table column width */
| Edit screen for duration-based events. | Edit screen for instant events. | Interface for inviting users to an event. | display: inline-block; /* Prevents it from affecting the layout */
text-align: left; /* Aligns text for better readability */
}
| ![Duration Event Details](showcase/09_duration_event_details.png) | ![Instant Event Details](showcase/10_instant_event_details.png) | ![Categories Overview](showcase/11_categories.png) | summary {
| ----------------------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------- | cursor: pointer; /* Makes it clear that the title is expandable */
| Detailed view of a duration-based event. | Detailed view of an instant event. | List of event categories of the user. | }
</style>
| ![Create New Category](showcase/12_new_category.png) | ![Updated Categories](showcase/13_categories_with_new.png) | ![Settings Screen](showcase/14_settings.png) | <table>
| ---------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- | <!-- First Image Row -->
| Form to create a new category. | Updated list with a newly added category. | Settings menu for app configuration. Only available when logged in. | <tr>
<th>
<details>
<summary>📶 API Unreachable</summary>
<div style="max-width: 250px;">Error screen, shown whenever the API becomes unreachable.</div>
</details>
</th>
<th>
<details>
<summary>🔒 Login Screen</summary>
<div style="max-width: 250px;">Login screen for user authentication, first screen you will face when you start the app for the first time.</div>
</details>
</th>
<th>
<details>
<summary>🔧 Base URL Change</summary>
<div style="max-width: 250px;">Screen to change the API base URL, available from login, register & API unreachable pages (doesn't require being signed in).</div>
</details>
</th>
</tr>
<tr>
<td>
<img src="showcase/01_api_unreachable.png" alt="API Unreachable" />
</td>
<td>
<img src="showcase/02_login.png" alt="Login Screen" />
</td>
<td>
<img src="showcase/02_login_base_url_change.png" alt="Base URL Change" />
</td>
</tr>
| ![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) | <!-- Second Image Row -->
| ---------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | <tr>
| Notification about an (incomming) event invite. | Preview of the event from the invite. | Notification for the (incomming) invite after accepting (already marked read). | <th>
<details>
<summary>📝 Register Screen</summary>
<div style="max-width: 250px;">User registration screen.</div>
</details>
</th>
<th>
<details>
<summary>📆 Month View</summary>
<div style="max-width: 250px;">Monthly calendar view to browse events, the screen shown immediately after login.</div>
</details>
</th>
<th>
<details>
<summary>📅 Day View</summary>
<div style="max-width: 250px;">Daily event view, listing the events for that day.</div>
</details>
</th>
</tr>
<tr>
<td>
<img src="showcase/03_register.png" alt="Register Screen" />
</td>
<td>
<img src="showcase/04_month_view.png" alt="Month View" />
</td>
<td>
<img src="showcase/05_day_view.png" alt="Day View" />
</td>
</tr>
| ![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) | <!-- Repeat for other rows -->
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | </table>
| 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). |
| ![Notifications Cleared](showcase/21_notifications_cleared.png) |
| --------------------------------------------------------------- |
| Screen showing cleared notifications. |