The Lost and Found App is a mobile application developed as part of a project at IIT Patna. It provides a platform for users to report lost items and helps others to find and return them. The app includes user authentication and login features to enhance security and privacy.
- User Authentication: Secure user registration and login functionality.
- Lost Item Reporting: Users can report lost items with details like description, location, and contact information.
- Found Item Listing: Allows users to browse and search for found items.
- Contact Matching: Helps match lost items with found items based on descriptions.
- User Profiles: Users can create and edit their profiles, including contact details and preferences.
- Clone the Repository:
git clone https://github.com/yourusername/lost-and-found-app.git
- Open in Android Studio:
- Launch Android Studio.
- Select "Open an existing Android Studio project."
- Navigate to the cloned repository and select the project folder.
- Configure Firebase:
- Set up a Firebase project and configure it with your app. Update the
google-services.jsonfile. - Enable authentication and Firestore in Firebase.
- Build and Run:
- Build and run the app on your Android emulator or physical device.
- User Registration and Login:
- Create an account using your email or sign in if you already have one.
- Report a Lost Item:
- Click on the "Report Lost Item" button.
- Fill in the details about the lost item, including description and location.
- Submit the report.
- Browse Found Items:
- View a list of found items posted by other users.
- Use the search feature to filter items by keywords or location.
- Match Lost and Found Items:
- The app uses an algorithm to match lost and found items based on descriptions.
- When a potential match is found, users are notified.
- User Profile:
- Customize your user profile, including contact information and preferences.
The codebase is organized as follows:
app/: Contains the main Android application code.src/: Source code for the app.main/: Main application code.res/: Resources, including layouts, drawables, and values.firebase/: Configuration files and Firebase-related code.gradle/: Gradle build scripts.build.gradle: Project-level Gradle build file.README.md: This documentation.
Contributions to the Lost and Found App are welcome! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and test them thoroughly.
- Create a pull request, describing your changes and the problem they solve.