Skip to content

Adithya-Rathod/LostAndFound-App

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lost and Found App

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.

Table of Contents

Features

  • 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.

Installation

  1. Clone the Repository:

git clone https://github.com/yourusername/lost-and-found-app.git

  1. Open in Android Studio:
  • Launch Android Studio.
  • Select "Open an existing Android Studio project."
  • Navigate to the cloned repository and select the project folder.
  1. Configure Firebase:
  • Set up a Firebase project and configure it with your app. Update the google-services.json file.
  • Enable authentication and Firestore in Firebase.
  1. Build and Run:
  • Build and run the app on your Android emulator or physical device.

Usage

  1. User Registration and Login:
  • Create an account using your email or sign in if you already have one.
  1. 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.
  1. Browse Found Items:
  • View a list of found items posted by other users.
  • Use the search feature to filter items by keywords or location.
  1. 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.
  1. User Profile:
  • Customize your user profile, including contact information and preferences.

Code Structure

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.

Contributing

Contributions to the Lost and Found App are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and test them thoroughly.
  4. Create a pull request, describing your changes and the problem they solve.

About

A working Lost and found app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Kotlin 88.2%
  • Java 11.8%