/FindMeNow-Team

This repository contains project files for the FindMeNow App.

Primary LanguagePython

FindMeNow - Lost and Found App

Table of Contents

  • Introduction
  • Features
  • Technologies Used
  • Getting Started
  • Usage
  • Contributing
  • License

Introduction

FindMeNow is a user-friendly and efficient Lost and Found application designed to simplify the process of locating and retrieving lost belongings. It offers a centralized platform where users can report lost items, search for found items, and facilitate their return. Whether you've misplaced your keys, left your phone on public transport, or found someone else's lost item, FindMeNow has got you covered.

This repository contains the collaborative development efforts of our team of four members to create this application. We believe in making a positive impact by helping people find their lost items and fostering a sense of community responsibility.

Features

  • User Registration and Authentication: Ensure data security and personalization through user accounts.
  • Item Reporting: Easily report lost items with descriptions, locations, dates, and photos.
  • Item Listing and Search: Search for lost items based on keywords, categories, or location.
  • Item Matching: An intelligent algorithm matches found items with reported lost items.
  • User Interaction: Users can communicate through the platform to arrange item return or collection.
  • Geolocation (Optional): Real-time tracking for lost items to simplify the retrieval process.

Technologies Used

  • Python (Flask framework for backend development)
  • HTML/CSS for front-end design
  • JavaScript for interactive user experiences
  • Database (e.g., SQLite or PostgreSQL) for storing lost and found items
  • Flask extensions for user authentication and data handling
  • Geolocation APIs for item tracking (optional)

Getting Started

To get started with the FindMeNow app locally, follow these steps:

  1. Clone this repository:

    git clone https://github.com/your-username/FindMeNow-Team.git
cd FindMeNow-Team

  2. Create a virtual environment (optional but recommended):

    python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate

  3. Install the required dependencies:

    pip install -r requirements.txt

  4. Configure your environment variables, database, and any optional settings (refer to our config.py).

  5. Run the Flask application:

    flask run

  6. Access the app in your web browser at http://localhost:5000.

Usage

  1. User Registration and Login: Create an account or log in to access the features.

  2. Report Lost Items: Use the "Report Lost Item" feature to provide details about your lost item.

  3. Search for Found Items: Utilize the search functionality to look for found items that match your lost item.

  4. Connect with Users: Communicate with users who have found your lost item to arrange its return.

  5. Contribute: If you're a developer, feel free to contribute to the project by opening issues or submitting pull requests.

Contributing

We welcome contributions from the community. If you'd like to contribute to the FindMeNow project, please follow our contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.