https://github.com/tutorialsandroid/resident
https://github.com/tutorialsandroid/resident
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tutorialsandroid/resident
- Owner: TutorialsAndroid
- Created: 2024-07-11T06:17:52.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-30T06:04:38.000Z (over 1 year ago)
- Last Synced: 2024-07-30T09:23:06.990Z (over 1 year ago)
- Language: Dart
- Size: 4.34 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Resident | Society Management App
Welcome to the **Resident | Society Management App**! This Flutter-based app is designed to streamline society management by enabling easy communication, bill payments, notices, and more for residents of gated communities or apartment complexes.
## Features
- **Resident Login**: Secure login system for authenticated residents.
- **Prepaid Meter Management**: View, manage, and recharge prepaid meters with a user-friendly interface.
- **SOS Feature**: Quickly send SOS alerts in emergencies.
- **Help Desk**: Submit service requests and communicate with management.
- **Notice Board**: Stay updated with the latest community announcements.
- **Local Directory**: Access a directory of local services such as plumbers, electricians, and more.
- **Amenities Booking**: Reserve community amenities like the gym, pool, or clubhouse.
## Screenshots
## Installation
To run the project locally, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/Sakshi-2508/Resident.git
cd resident-society-management-app
```
2. **Install dependencies**:
```bash
flutter pub get
```
3. **Run the app**:
```bash
flutter run
```
Make sure you have Flutter installed. If not, follow the instructions at the [official Flutter website](https://flutter.dev/docs/get-started/install).
## Folder Structure
The main files in the project are organized as follows:
```
lib/
|- screens/
| |- login_screen.dart # Login page for residents
| |- prepaid_meter.dart # Prepaid meter management
| |- sos_page.dart # SOS feature UI
| |- help_desk.dart # Help Desk UI
| |- notice_board.dart # Notice Board UI
| |- local_directory.dart # Local Directory page
| |- amenities_page.dart # Amenities Booking UI
|- models/ # Data models for various components
|- services/ # API services and data handling
```
## Technologies Used
- **Flutter**: For building the cross-platform UI.
- **Dart**: Flutter’s programming language.
- **Firebase** (optional): For backend services, authentication, and database.
## Contributions
Contributions are welcome! Feel free to submit a pull request or open an issue if you encounter any bugs or have suggestions for new features.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.