docs: completely analyze project and add ascii art to README.md

This commit is contained in:
2026-03-07 16:15:55 +05:30
parent 07f73b3318
commit 5e70b2d9a9

107
README.md
View File

@@ -1,12 +1,23 @@
<div align="center">
<pre>
______ _ _ __
| ____| | | (_)/ _|
| |__ __ _____ _ __ __| |_ _| |_ _ _
| __| \ \ / / _ \ '_ \/ _` | | | _| | | |
| |____ \ V / __/ | | | (_| | | | | | |_| |
|______| \_/ \___|_| |_|\__,_|_|_|_| \__, |
__/ |
|___/
</pre>
# 🎟️ Eventify Frontend
*A beautifully crafted Flutter application for event management, discovery, and attendance.*
*A beautifully crafted, fully responsive Flutter application for event management, discovery, and attendance.*
[![Flutter](https://img.shields.io/badge/Flutter-%2302569B.svg?style=for-the-badge&logo=flutter&logoColor=white)](https://flutter.dev/)
[![Dart](https://img.shields.io/badge/Dart-%230175C2.svg?style=for-the-badge&logo=dart&logoColor=white)](https://dart.dev/)
[![Platform](https://img.shields.io/badge/Platform-iOS%20%7C%20Android-lightgrey?style=for-the-badge)](#)
[![Platform](https://img.shields.io/badge/Platform-iOS%20%7C%20Android%20%7C%20Web%20%7C%20Desktop-lightgrey?style=for-the-badge)](#)
</div>
@@ -14,27 +25,57 @@
## 🌟 Overview
**Eventify Frontend** is the official Flutter mobile version of the [Eventify Dashboard](https://code.bshtech.net/Sicherhaven/mvnew.eventifyplus.com). Built with performance and elegance in mind, it delivers a dynamic native experience offering the same powerful features as its web counterpart.
**Eventify Frontend** is the official Flutter mobile and desktop application counterpart of the [Eventify Dashboard (React)](https://code.bshtech.net/Sicherhaven/mvnew.eventifyplus.com). Built with performance and elegance in mind, it delivers a dynamic native experience offering the same powerful features as its web counterpart.
Enjoy seamless event discovery, scheduling, and user engagement right at your fingertips. Whether you're an attendee looking for the next big conference or a user managing your personal agenda, Eventify has you covered.
Whether you're an attendee looking for the next big conference or an administrator managing your personal agenda, Eventify has you covered. The application seamlessly adapts its UI between mobile and desktop form-factors.
## ✨ Key Features
## ✨ Key Features & Capabilities
- **📅 Interactive Calendars:** Effortlessly browse and manage your events using integrated calendar views.
- **📍 Location Services:** Precise event mapping and real-time location detection powered by cutting-edge geo-packages.
- **📸 Media Integration:** Instantly share moments or update your profile via secure image picking.
- **💾 Fast & Reliable:** Offline-ready experiences utilizing efficient local storage.
- **🎨 Sleek UI/UX:** A pixel-perfect interface translated beautifully into a responsive Flutter application.
- **🚀 Polished Details:** Brand-aligned custom launcher icons and native splash screens built right in.
- **📱 Fully Responsive Dual-Layouts:** Distinct, optimized UI layouts for both Mobile and Desktop screens (`DesktopLoginScreen` vs `LoginScreen`, `HomeDesktopScreen` vs `HomeScreen`) utilizing a strict breakpoint system.
- **🌗 Native Theming & Dark Mode:** Integrated `ThemeManager` supporting real-time reactive toggles between fully customized Light and Dark modes.
- **📅 Interactive Calendars & Booking:** Effortlessly browse and manage your events and tickets using integrated calendar views (`table_calendar`).
- **📍 Location Services:** Precise event mapping and real-time location detection powered by cutting-edge geo-packages (`geocoding` & `geolocator`).
- **📸 Media Integration:** Instantly share moments or update your profile via secure native image picking (`image_picker`).
- **💾 Fast & Reliable Local Storage:** Lightning-fast offline-ready credential and preference caching using `shared_preferences`.
- **🎨 Sleek UI/UX:** A pixel-perfect interface translated beautifully into a responsive application, complete with deep profile management, customized settings, and ticket overview screens.
- **🚀 Polished Details:** Brand-aligned custom launcher icons (`flutter_launcher_icons`) and native splash screens (`flutter_native_splash`) built right in.
## 🛠️ Tech Stack & Dependencies
## 🛠️ Architecture & Tech Stack
- **Framework:** [Flutter](https://flutter.dev/)
- **Core Integrations:**
- `shared_preferences` - Local data caching
- `image_picker` - Media selection
- `table_calendar` - Advanced date management
- `geolocator` & `geocoding` - Location tracking and address resolution
This project strictly adheres to a modularized folder structure designed for scalability:
- **Core Framework:** [Flutter](https://flutter.dev/) (SDK: `^3.0.0` target)
- **Local Data Caching:** `shared_preferences`
- **Media Management:** `image_picker`
- **Date Management:** `table_calendar`
- **Location & Analytics:** `geolocator` & `geocoding`
### 🏗️ Directory Organization
```text
lib/
├── core/
│ ├── api/ # API interceptors and client setup
│ ├── storage/ # Local caching implementations
│ ├── constants.dart # Environment constants and static keys
│ ├── theme_manager.dart# Dark/Light mode state management
│ └── app_decoration.dart
├── features/
│ ├── auth/ # Authentication BLOC/Services
│ └── events/ # Core event manipulation logic
├── screens/
│ ├── booking_screen.dart # Event booking flow
│ ├── calendar_screen.dart # Interactive calendar tools
│ ├── home_screen.dart # Mobile Home Feed
│ ├── home_desktop_screen.dart # Desktop Home Dashboard
│ ├── login_screen.dart # Mobile Login
│ ├── desktop_login_screen.dart # Desktop Login
│ ├── profile_screen.dart # User user settings
│ ├── search_screen.dart # Event lookups
│ ├── responsive_layout.dart # Core Layout Builder
│ └── ...
└── main.dart # Application Entry Point & Route Builder
```
## 🚀 Getting Started
@@ -44,7 +85,7 @@ Follow these steps to get your development environment set up and running locall
- [Flutter SDK](https://docs.flutter.dev/get-started/install) installed on your machine.
- An IDE with Flutter support (VS Code, Android Studio, IntelliJ).
- An active iOS Simulator or Android Emulator (or a physical device).
- An active iOS Simulator, Android Emulator, or a Web/Desktop target enabled.
### Installation
@@ -63,27 +104,23 @@ Follow these steps to get your development environment set up and running locall
flutter pub get
```
4. **Run the app**
4. **Regenerate Assets (Optional but recommended)**
If you have updated icons or splash screens, run:
```bash
flutter pub run flutter_launcher_icons:main
flutter pub run flutter_native_splash:create
```
5. **Run the app**
```bash
flutter run
```
## 🏗️ Project Structure
## 🔐 Authentication & State
```text
Eventify-frontend/
├── android/ # Native Android configuration files
├── ios/ # Native iOS configuration files
├── lib/ # Core Flutter application code
│ └── main.dart # App entry point
├── assets/ # Images, Splash Icons, App Icons
├── pubspec.yaml # Project metadata & dependencies
└── README.md # You are here!
```
## 📚 Further Reading
For help getting started with Flutter development, view the [online documentation](https://docs.flutter.dev/), which offers tutorials, samples, guidance on mobile development, and a full API reference.
The app uses an initialization check in `main.dart` that intercepts the launch view to determine if the user has an existing cached session (`email` stored via `SharedPreferences`).
- If authenticated: Safely navigates the user to the `HomeScreen` / `HomeDesktopScreen`.
- If unauthenticated: Routes the user to the `LoginScreen` / `DesktopLoginScreen`.
---