diff --git a/README.md b/README.md index 58e7f73..87c7392 100644 --- a/README.md +++ b/README.md @@ -40,34 +40,170 @@ Repository](https://git.itsdrike.com/ap7pd/event-management-backend). 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) | -| --------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------- | -| 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. | + -| ![Create New Category](showcase/12_new_category.png) | ![Updated Categories](showcase/13_categories_with_new.png) | ![Settings Screen](showcase/14_settings.png) | -| ---------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- | -| Form to create a new category. | Updated list with a newly added category. | Settings menu for app configuration. Only available when logged in. | +
📶 API Unreachable | +🔒 Login Screen | +🔧 Base URL Change | +
---|---|---|
+ + | ++ + | ++ + | +
Error screen, shown whenever the API becomes unreachable. | +Login screen for user authentication, first screen you will face when you start the app for the first time. | +Screen to change the API base URL, available from login, register & API unreachable pages (doesn't require being signed in). | +
📝 Register Screen | +📆 Month View | +📅 Day View | +
+ + | ++ + | ++ + | +
User registration screen. | +Monthly calendar view to browse events, the screen shown immediately after login. | +Daily event view, listing the events for that day. | +
⏳ Edit Duration Event | +⚡ Edit Instant Event | +📨 Invite User to Event | +
+ + | ++ + | ++ + | +
Edit screen for duration-based events. | +Edit screen for instant events. | +Interface for inviting users to an event. | +
⏱️ Duration Event Details | +🔍 Instant Event Details | +📂 Categories Overview | +
+ + | ++ + | ++ + | +
Detailed view of a duration-based event. | +Detailed view of an instant event. | +List of event categories of the user. | +
➕ Create New Category | +🆕 Updated Categories Overview | +⚙️ Settings Screen | +
+ + | ++ + | ++ + | +
Form to create a new category or edit an existing one. | +Updated list with a newly added category. | +Settings menu for configuring user details & the base url. This screen is only available to logged in users. | +
🔔 Notification: Invite | +👀 Invite Preview | +✅ Notification: Accepted | +
+ + | ++ + | ++ + | +
Notification about an incoming event invite. | +Preview of the event from the invite (after clicking the eye button). | +That same notification for the invite, after acceptance. This notification also doesn't have the orange bar on the left, meaning it's marked as read. | +