Skip to content

KalpakPS/LoFo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LoFo - Lost and Found Platform

LoFo is a web-based application designed to help users report lost and found items, manage claims, and communicate with each other to recover their belongings.

🚀 Features

  • User Authentication: Custom user model with profile pictures and phone numbers.
  • Reporting: Report lost items or found items with categories, descriptions, images, and locations.
  • Claim Management: Submit claim requests for found/lost items with ownership proof.
  • Messaging System: Built-in chat for users to communicate directly.
  • Admin Dashboard: Comprehensive management for reports, users, and messages via AdminApp.
  • API Support: RESTful endpoints powered by Django REST Framework.

🛠️ Tech Stack

  • Backend: Django 6.0
  • Database: SQLite (Development)
  • API: Django REST Framework
  • Environment: python-dotenv
  • Image Processing: Pillow

📦 Installation & Setup

1. Clone the Repository

git clone <repository-url>
cd LoFo

2. Set up Virtual Environment

python -m venv .venv
# On Windows
.venv\Scripts\activate
# On macOS/Linux
source .venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

4. Configuration

Create a .env file in the LoFo/ directory (where settings.py is located) and copy the values from .env.example:

cp .env.example LoFo/.env

Note: Update the email settings in .env to enable email notifications.

5. Database Setup

python manage.py migrate

6. Create Superuser

python manage.py createsuperuser

7. Run the Server

python manage.py run server

Access the application at http://127.0.0.1:8000/.

📁 Project Structure

  • WebApp/: Main application containing core logic for lost/found reporting, messaging, and user profiles.
  • AdminApp/: Custom admin interface and extra management tools.
  • LoFo/: Project configuration, settings, and URL routing.
  • media/: Storage for uploaded item images and profile pictures.
  • static/: Global CSS, JavaScript, and asset files.

About

LoFo is a web-based application designed to help users report lost and found items, manage claims, and communicate with each other to recover their belongings.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors