feat: Add basic readme
This commit is contained in:
parent
c6c64bfa3f
commit
1cab0528ba
33
README.md
Normal file
33
README.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
# Event Management Frontend
|
||||
|
||||
The Event Management Frontend is a native Android application developed in
|
||||
Kotlin. This app provides a comprehensive calendar-based event management
|
||||
system designed for seamless user interaction.
|
||||
|
||||
This project was created as the final assignment for **AP7PD** and **AP7MP** subjects.
|
||||
|
||||
It integrates with a custom backend REST API to manage users, events,
|
||||
attendees, and categories effectively.
|
||||
|
||||
## Overview / Key Features
|
||||
|
||||
- **Monthly Calendar View**: View events in a grid layout by weeks and days.
|
||||
- **Daily View**: Easily browse and manage daily events.
|
||||
- **Event Management**: Create, edit, and delete events with support for categories and attendees.
|
||||
- **User Authentication**: Register and log in with robust access and refresh
|
||||
token support, ensuring secure and seamless user sessions.
|
||||
- **Error Handling**: Gracefully handles API errors, including scenarios where
|
||||
the backend is unreachable.
|
||||
|
||||
## Backend requirements
|
||||
|
||||
The application requires a running backend API for full functionality. The
|
||||
backend is implemented using FastAPI in Python.
|
||||
|
||||
You can find the source code and detailed deployment instructions for the
|
||||
backend API at: [Event Management Backend
|
||||
Repository](https://git.itsdrike.com/ap7pd/event-management-backend).
|
||||
|
||||
> [!TIP]
|
||||
> The app supports dynamic configuration of the API base URL, allowing you to
|
||||
> deploy the backend on any server or cloud provider of your choice.
|
Loading…
Reference in a new issue