Lawino commited on
Commit
128e9b6
Β·
verified Β·
1 Parent(s): 37f4313

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -32
README.md CHANGED
@@ -14,10 +14,12 @@ pinned: false
14
  [![Python 3.10](https://img.shields.io/badge/Python-3.10-blue.svg)](https://python.org)
15
  [![Flask](https://img.shields.io/badge/Flask-3.0-green.svg)](https://flask.palletsprojects.com)
16
  [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
17
- [![Hugging Face](https://img.shields.io/badge/πŸ€—-Hugging%20Face-ff9f0e)](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
- - [Contributing](#-contributing)
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 (report lost, search, claim, etc.)
72
  - **Item Categorization** β€” Auto-tags items into 7+ categories
73
  - **Color Detection** β€” Extracts dominant colors from images
74
- - **Match Scoring** β€” Multi-factor similarity algorithm (category, location, color, brand, date)
75
- - **OpenRouter Integration** β€” Supports multiple LLM models (Gemini, Llama, Phi)
76
 
77
  ### πŸ”§ Admin Features
78
- - **Admin Panel** β€” Full CRUD operations on users, items, claims
79
- - **Analytics Dashboard** β€” Charts for daily activity and item distribution
80
- - **User Management** β€” Ban/unban, delete users with one click
81
- - **Claim Review** β€” Approve/reject claims with admin notes
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
- ### Hugging Face Spaces Deployment (Easiest)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
109
 
110
- 1. **Create a new Space** on [Hugging Face Spaces](https://huggingface.co/new-space)
111
- - Choose **Docker** as the SDK
112
- - Select **Blank** template
113
- - Set Space name (e.g., `campus-recovery-network`)
114
 
115
- 2. **Configure Secrets** in Space Settings β†’ Repository Secrets:
116
- ```bash
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
  [![Python 3.10](https://img.shields.io/badge/Python-3.10-blue.svg)](https://python.org)
15
  [![Flask](https://img.shields.io/badge/Flask-3.0-green.svg)](https://flask.palletsprojects.com)
16
  [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
17
+ [![Hugging Face](https://img.shields.io/badge/πŸ€—-Hugging%20Face-ff9f0e)](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