Khuje Pai (meaning "Found" in Bangla) is a community-driven mobile application designed to simplify the process of reporting and finding lost or found items. Built with Flutter and Firebase, this app empowers users to connect, collaborate, and contribute to their community by sharing and recovering lost belongings.
- Displays a consolidated feed of the latest lost and found posts.
- Navigate seamlessly between Home, My Posts, Create Post, and Profile tabs.
- Basically the Home Page is the main newsfeed of the app where all the Lost/Found posts are shown.
- There is option for Searching in the Home Page.
- Add new posts with the following details:
- 📷 Image: Upload from the gallery, take a photo, or use an image URL.
- 📝 Caption: Provide a description of the item.
- 📍 Location: Specify where the item was lost/found.
- View, edit, or delete your posts.
- Displays user information: Name, Email, Phone Number, and Profile Picture.
- Update your profile details through simple dialogs.
- Secure registration and login powered by Firebase Authentication.
- Logout functionality to switch accounts.
- Real-time data fetching and synchronization with Firebase Firestore.
Here’s a high-level diagram of the app’s workflow:
Technology | Description |
---|---|
Flutter | Frontend framework for building UIs. |
Firebase | Backend services for authentication and data storage. |
Firestore | Database for storing posts and user data. |
Cloudinary | For storing profile pics and Post photos |
Follow these steps to get a local copy of the project up and running:
git clone https://github.com/Hasib-39/khuje_pai.git
cd khuje_pai
Ensure Flutter is installed and configured. Run:
flutter pub get
- Create a Firebase project at Firebase Console.
- Add an Android/iOS app and download the configuration files:
google-services.json
(for Android).GoogleService-Info.plist
(for iOS).
- Place these files in the respective directories:
android/app/
(forgoogle-services.json
).ios/Runner/
(forGoogleService-Info.plist
).
- Enable Firestore and Firebase Authentication.
Launch the app on an emulator or connected device:
flutter run
khuje_pai/
├── android/ # Android-specific configurations
├── ios/ # iOS-specific configurations
├── lib/ # Main Flutter codebase
│ ├── models/ # Data models
│ ├── screens/ # UI screens
│ ├── controllers/ # State management and controllers
│ ├── widgets/ # Reusable UI components
├── assets/ # Static assets like images and icons
└── pubspec.yaml # Project dependencies and metadata
We welcome contributions! Here's how you can contribute:
- Fork the repository.
- Create a new branch for your feature/bugfix:
git checkout -b feature-name
- Commit your changes:
git commit -m "Add detailed feature"
- Push the branch:
git push origin feature-name
- Open a Pull Request.
This project is licensed under the MIT License. See the LICENSE file for details.
Thanks to everyone contributing to and using Khuje Pai. Together, let’s make finding lost items more efficient and community-driven!
For any queries or collaboration opportunities, feel free to reach out:
Hasib Altaf
📧 Email: [email protected]
This version is more professional, with added diagrams and clear sections, making it easier for users and contributors to understand and navigate the project. Let me know if you’d like to tweak or add more details!