feat: Add showcase images to readme
36
README.md
|
@ -35,3 +35,39 @@ Repository](https://git.itsdrike.com/ap7pd/event-management-backend).
|
|||
> (<http://localhost:8000>) and set the base URL to `http://10.0.2.2:8000`.
|
||||
> This will allow the Android emulator to access the local backend server. Note
|
||||
> that this is also the default value.
|
||||
|
||||
## Showcase
|
||||
|
||||
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. |
|
||||
|
||||
| ![Register Screen](showcase/03_register.png) | ![Month View](showcase/04_month_view.png) | ![Day View](showcase/05_day_view.png) |
|
||||
| -------------------------------------------- | ----------------------------------------- | ------------------------------------------------- |
|
||||
| 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) |
|
||||
| ----------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| Edit screen for duration-based events. | Edit screen for instant events. | Interface for inviting users to an event. |
|
||||
|
||||
| ![Duration Event Details](showcase/09_duration_event_details.png) | ![Instant Event Details](showcase/10_instant_event_details.png) | ![Categories Overview](showcase/11_categories.png) |
|
||||
| ----------------------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------- |
|
||||
| Detailed view of a duration-based event. | Detailed view of an instant event. | List of event categories of the user. |
|
||||
|
||||
| ![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. |
|
||||
|
||||
| ![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) |
|
||||
| ---------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| Notification about an (incomming) event invite. | Preview of the event from the invite. | Notification for the (incomming) invite after accepting (already marked read). |
|
||||
|
||||
| ![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) |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| 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. |
|
||||
|
|
BIN
showcase/01_api_unreachable.png
Normal file
After Width: | Height: | Size: 34 KiB |
BIN
showcase/02_login.png
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
showcase/02_login_base_url_change.png
Normal file
After Width: | Height: | Size: 28 KiB |
BIN
showcase/03_register.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
showcase/04_month_view.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
showcase/05_day_view.png
Normal file
After Width: | Height: | Size: 49 KiB |
BIN
showcase/06_duration_event_edit.png
Normal file
After Width: | Height: | Size: 42 KiB |
BIN
showcase/07_instant_event_edit.png
Normal file
After Width: | Height: | Size: 43 KiB |
BIN
showcase/08_invite_user_to_event.png
Normal file
After Width: | Height: | Size: 39 KiB |
BIN
showcase/09_duration_event_details.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
showcase/10_instant_event_details.png
Normal file
After Width: | Height: | Size: 41 KiB |
BIN
showcase/11_categories.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
showcase/12_new_category.png
Normal file
After Width: | Height: | Size: 22 KiB |
BIN
showcase/13_categories_with_new.png
Normal file
After Width: | Height: | Size: 23 KiB |
BIN
showcase/14_settings.png
Normal file
After Width: | Height: | Size: 31 KiB |
BIN
showcase/15_notification_invite_bob.png
Normal file
After Width: | Height: | Size: 26 KiB |
BIN
showcase/16_invite_event_details_preview.png
Normal file
After Width: | Height: | Size: 45 KiB |
BIN
showcase/17_notification_invite_accepted_bob.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
showcase/18_day_view_invited_event_bob.png
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
showcase/19_invited_event_details_bob.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
showcase/20_notification_invite_accepted_john.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
showcase/21_notifications_cleared.png
Normal file
After Width: | Height: | Size: 14 KiB |