docs: update and beautify README.md
This commit is contained in:
94
README.md
94
README.md
@@ -1,16 +1,90 @@
|
||||
# figma_events
|
||||
<div align="center">
|
||||
|
||||
A new Flutter project.
|
||||
# 🎟️ Eventify Frontend
|
||||
|
||||
## Getting Started
|
||||
*A beautifully crafted Flutter application for event management, discovery, and attendance.*
|
||||
|
||||
This project is a starting point for a Flutter application.
|
||||
[](https://flutter.dev/)
|
||||
[](https://dart.dev/)
|
||||
[](#)
|
||||
|
||||
A few resources to get you started if this is your first Flutter project:
|
||||
</div>
|
||||
|
||||
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
|
||||
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
|
||||
---
|
||||
|
||||
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.
|
||||
## 🌟 Overview
|
||||
|
||||
**Eventify** is a modern, intuitive, and feature-rich event application built with Flutter. It brings the power of seamless event discovery, scheduling, and user engagement right to your fingertips. Whether you're an attendee looking for the next big conference or a user managing your personal agenda, Eventify has you covered.
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
- **📅 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.
|
||||
|
||||
## 🛠️ Tech Stack & Dependencies
|
||||
|
||||
- **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
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
Follow these steps to get your development environment set up and running locally.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [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).
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
git clone https://code.bshtech.net/Sicherhaven/Eventify-frontend.git
|
||||
```
|
||||
|
||||
2. **Navigate to the directory**
|
||||
```bash
|
||||
cd Eventify-frontend
|
||||
```
|
||||
|
||||
3. **Install dependencies**
|
||||
```bash
|
||||
flutter pub get
|
||||
```
|
||||
|
||||
4. **Run the app**
|
||||
```bash
|
||||
flutter run
|
||||
```
|
||||
|
||||
## 🏗️ Project Structure
|
||||
|
||||
```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.
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<sub>Built with ❤️ by the Eventify Team</sub>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user