Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -14,10 +14,12 @@ pinned: false
|
|
| 14 |
[](https://python.org)
|
| 15 |
[](https://flask.palletsprojects.com)
|
| 16 |
[](LICENSE)
|
| 17 |
-
[](https://huggingface.co/spaces)
|
| 18 |
|
| 19 |
> **AI-Powered Campus Lost & Found System** β Reunite lost items with their owners using intelligent matching, image recognition, and a modern web interface.
|
| 20 |
|
|
|
|
|
|
|
| 21 |
---
|
| 22 |
|
| 23 |
## π Table of Contents
|
|
@@ -26,16 +28,11 @@ pinned: false
|
|
| 26 |
- [Features](#-features)
|
| 27 |
- [Tech Stack](#-tech-stack)
|
| 28 |
- [Quick Start](#-quick-start)
|
| 29 |
-
- [Hugging Face Spaces Deployment](#hugging-face-spaces-deployment)
|
| 30 |
-
- [Docker Deployment](#docker-deployment-recommended)
|
| 31 |
-
- [Local Development](#local-development)
|
| 32 |
- [Configuration](#-configuration)
|
| 33 |
- [Admin Panel](#-admin-panel)
|
| 34 |
-
- [API Endpoints](#-api-endpoints)
|
| 35 |
- [Environment Variables](#-environment-variables)
|
| 36 |
- [Troubleshooting](#-troubleshooting)
|
| 37 |
-
- [
|
| 38 |
-
- [License](#-license)
|
| 39 |
|
| 40 |
---
|
| 41 |
|
|
@@ -68,24 +65,18 @@ pinned: false
|
|
| 68 |
- **AI Chatbot** β Conversational assistant for guided reporting
|
| 69 |
|
| 70 |
### π€ AI Capabilities
|
| 71 |
-
- **Intent Detection** β Understands user queries
|
| 72 |
- **Item Categorization** β Auto-tags items into 7+ categories
|
| 73 |
- **Color Detection** β Extracts dominant colors from images
|
| 74 |
-
- **Match Scoring** β Multi-factor similarity algorithm
|
| 75 |
-
- **OpenRouter Integration** β Supports multiple LLM models
|
| 76 |
|
| 77 |
### π§ Admin Features
|
| 78 |
-
- **Admin Panel** β Full CRUD operations
|
| 79 |
-
- **Analytics Dashboard** β Charts for daily activity
|
| 80 |
-
- **User Management** β Ban/unban, delete users
|
| 81 |
-
- **Claim Review** β Approve/reject
|
| 82 |
- **Export Data** β CSV exports for users and items
|
| 83 |
-
- **Manual Matching** β Trigger matching engine on demand
|
| 84 |
-
|
| 85 |
-
### π± Responsive Design
|
| 86 |
-
- Dark/Light theme toggle
|
| 87 |
-
- Mobile-first layout
|
| 88 |
-
- Works on desktop, tablet, and smartphone
|
| 89 |
|
| 90 |
---
|
| 91 |
|
|
@@ -105,17 +96,45 @@ pinned: false
|
|
| 105 |
|
| 106 |
## π Quick Start
|
| 107 |
|
| 108 |
-
###
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 109 |
|
| 110 |
-
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
- Set Space name (e.g., `campus-recovery-network`)
|
| 114 |
|
| 115 |
-
|
| 116 |
-
|
| 117 |
-
OPENROUTER_API_KEY=sk-or-v1-your-key-here
|
| 118 |
-
ADMIN_USERNAME=admin
|
| 119 |
-
ADMIN_PASSWORD=change_this_secure_password
|
| 120 |
-
ADMIN_EMAIL=admin@campus.edu
|
| 121 |
-
FLASK_SECRET_KEY=your_random_secret_key_32_chars_min
|
|
|
|
| 14 |
[](https://python.org)
|
| 15 |
[](https://flask.palletsprojects.com)
|
| 16 |
[](LICENSE)
|
| 17 |
+
[](https://huggingface.co/spaces/Lawino/lost_found)
|
| 18 |
|
| 19 |
> **AI-Powered Campus Lost & Found System** β Reunite lost items with their owners using intelligent matching, image recognition, and a modern web interface.
|
| 20 |
|
| 21 |
+
**Live Demo:** [https://huggingface.co/spaces/Lawino/lost_found](https://huggingface.co/spaces/Lawino/lost_found)
|
| 22 |
+
|
| 23 |
---
|
| 24 |
|
| 25 |
## π Table of Contents
|
|
|
|
| 28 |
- [Features](#-features)
|
| 29 |
- [Tech Stack](#-tech-stack)
|
| 30 |
- [Quick Start](#-quick-start)
|
|
|
|
|
|
|
|
|
|
| 31 |
- [Configuration](#-configuration)
|
| 32 |
- [Admin Panel](#-admin-panel)
|
|
|
|
| 33 |
- [Environment Variables](#-environment-variables)
|
| 34 |
- [Troubleshooting](#-troubleshooting)
|
| 35 |
+
- [API Endpoints](#-api-endpoints)
|
|
|
|
| 36 |
|
| 37 |
---
|
| 38 |
|
|
|
|
| 65 |
- **AI Chatbot** β Conversational assistant for guided reporting
|
| 66 |
|
| 67 |
### π€ AI Capabilities
|
| 68 |
+
- **Intent Detection** β Understands user queries
|
| 69 |
- **Item Categorization** β Auto-tags items into 7+ categories
|
| 70 |
- **Color Detection** β Extracts dominant colors from images
|
| 71 |
+
- **Match Scoring** β Multi-factor similarity algorithm
|
| 72 |
+
- **OpenRouter Integration** β Supports multiple LLM models
|
| 73 |
|
| 74 |
### π§ Admin Features
|
| 75 |
+
- **Admin Panel** β Full CRUD operations at `/nimda`
|
| 76 |
+
- **Analytics Dashboard** β Charts for daily activity
|
| 77 |
+
- **User Management** β Ban/unban, delete users
|
| 78 |
+
- **Claim Review** β Approve/reject with admin notes
|
| 79 |
- **Export Data** β CSV exports for users and items
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 80 |
|
| 81 |
---
|
| 82 |
|
|
|
|
| 96 |
|
| 97 |
## π Quick Start
|
| 98 |
|
| 99 |
+
### Access the Live Application
|
| 100 |
+
|
| 101 |
+
Your application is live at: **https://huggingface.co/spaces/Lawino/lost_found**
|
| 102 |
+
|
| 103 |
+
### Configure Secrets (Required)
|
| 104 |
+
|
| 105 |
+
Go to your Space Settings β **Repository Secrets** and add:
|
| 106 |
+
|
| 107 |
+
| Secret Name | Required | Example Value |
|
| 108 |
+
|-------------|----------|---------------|
|
| 109 |
+
| `FLASK_SECRET_KEY` | **Yes** | `your_random_32_char_secret_key` |
|
| 110 |
+
| `OPENROUTER_API_KEY` | No | `sk-or-v1-xxxxx` (for AI features) |
|
| 111 |
+
| `ADMIN_USERNAME` | No | `admin` |
|
| 112 |
+
| `ADMIN_PASSWORD` | No | `ChangeMe123!` |
|
| 113 |
+
| `ADMIN_EMAIL` | No | `admin@campus.edu` |
|
| 114 |
+
|
| 115 |
+
### Default Admin Credentials (if not set)
|
| 116 |
+
- Username: `admin`
|
| 117 |
+
- Password: `admin123`
|
| 118 |
+
|
| 119 |
+
**β οΈ IMPORTANT:** Change these credentials immediately after first login!
|
| 120 |
+
|
| 121 |
+
### Local Development
|
| 122 |
+
|
| 123 |
+
```bash
|
| 124 |
+
# Clone the repository
|
| 125 |
+
git clone https://huggingface.co/spaces/Lawino/lost_found
|
| 126 |
+
cd lost_found
|
| 127 |
+
|
| 128 |
+
# Create virtual environment
|
| 129 |
+
python -m venv venv
|
| 130 |
+
source venv/bin/activate # On Windows: venv\Scripts\activate
|
| 131 |
+
|
| 132 |
+
# Install dependencies
|
| 133 |
+
pip install -r requirements.txt
|
| 134 |
|
| 135 |
+
# Set environment variables
|
| 136 |
+
export FLASK_SECRET_KEY="your-secret-key-here"
|
| 137 |
+
export OPENROUTER_API_KEY="your-api-key" # Optional
|
|
|
|
| 138 |
|
| 139 |
+
# Run the application
|
| 140 |
+
python app.py
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|