Skip to content

Commit a3e26ff

Browse files
Rudragupta8777Rudragupta8777
authored
Create README.md
1 parent 0722b14 commit a3e26ff

File tree

1 file changed

+218
-0
lines changed

1 file changed

+218
-0
lines changed

‎README.md‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
<div align="center">
2+
<img src="https://ik.imagekit.io/yourusername/findit-logo.png" alt="FindIt Logo" width="60%" />
3+
4+
# FindIT: Lost & Found App for VIT
5+
6+
<p align="center">
7+
<img src="https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white" />
8+
<img src="https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white" />
9+
<img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" />
10+
<img src="https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white" />
11+
<img src="https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=firebase&logoColor=black" />
12+
<img src="https://img.shields.io/badge/Cloudinary-3448C5?style=for-the-badge&logo=cloudinary&logoColor=white" />
13+
<img src="https://img.shields.io/badge/TensorFlow.js-FF6F00?style=for-the-badge&logo=tensorflow&logoColor=white" />
14+
</p>
15+
16+
<p align="center"><b>Find what's lost, return what's found — fast, secure and student-only.</b></p>
17+
</div>
18+
19+
<p align="center">
20+
<img src="https://ik.imagekit.io/yourusername/findit-screens.png" alt="FindIt App Screenshots" width="80%" />
21+
</p>
22+
23+
## 🌟 Overview
24+
25+
**FindIt** is a campus-exclusive platform built for VIT students to **report**, **search**, and **claim lost items**. With integrated image moderation, QR-based secure claims and a clean mobile interface — it ensures trust, security, and ease of use for the entire student community.
26+
27+
<div align="center">
28+
<table>
29+
<tr>
30+
<td width="50%">
31+
<h3 align="center">🎒 For Users</h3>
32+
<ul>
33+
<li>Post lost/found items with images</li>
34+
<li>Advanced search with filters</li>
35+
<li>Claim items via QR verification</li>
36+
<li>Track all your posts and claims</li>
37+
<li>Image moderation to prevent abuse</li>
38+
</ul>
39+
</td>
40+
<td width="50%">
41+
<h3 align="center">🔐 For Admins</h3>
42+
<ul>
43+
<li>Manage and moderate content</li>
44+
<li>Delete unsafe/inappropriate posts</li>
45+
<li>Track app versioning</li>
46+
<li>Admin-only secure endpoints</li>
47+
</ul>
48+
</td>
49+
</tr>
50+
</table>
51+
</div>
52+
53+
## ✨ Key Features
54+
55+
### 🧭 Lost & Found Flow
56+
57+
1. **Report** - Upload images, select category (lost/found), and describe the item
58+
2. **Moderate** - AI-based image moderation prevents NSFW/abusive content
59+
3. **Search** - Use filters or keywords to browse through reported items
60+
4. **Claim** - Found your item? Request claim using the secure QR flow
61+
5. **Verify** - Show your QR to the finder and verify ownership
62+
6. **Complete** - Item handed over, claim closed securely!
63+
64+
> **⚠️ Note:** All interactions are verified with VIT Google login. No outsiders allowed.
65+
66+
### 🛡️ Security Features
67+
68+
<div align="center">
69+
<table>
70+
<tr>
71+
<td align="center">
72+
<h3>🔐</h3> <b>VIT-Only Access</b><br>
73+
<small>Sign in with official college email via Firebase</small>
74+
</td>
75+
<td align="center">
76+
<h3>🖼️</h3> <b>AI Image Moderation</b><br>
77+
<small>NSFW detection via TensorFlow.js + NSFWJS</small>
78+
</td>
79+
<td align="center">
80+
<h3>🔄</h3> <b>Secure QR Claims</b><br>
81+
<small>Time-bound, JWT-authenticated QR codes</small>
82+
</td>
83+
<td align="center">
84+
<h3>🛠️</h3> <b>Admin Controls</b><br>
85+
<small>Manual moderation & unsafe post removal</small>
86+
</td>
87+
</tr>
88+
</table>
89+
</div>
90+
91+
## 🛠️ Tech Stack
92+
93+
<div align="center">
94+
<table>
95+
<tr>
96+
<td align="center"><img src="https://cdn.simpleicons.org/kotlin" width="50px"/><br/>Kotlin</td>
97+
<td align="center"><img src="https://cdn.simpleicons.org/nodedotjs" width="50px"/><br/>Node.js</td>
98+
<td align="center"><img src="https://cdn.simpleicons.org/mongodb" width="50px"/><br/>MongoDB</td>
99+
<td align="center"><img src="https://cdn.simpleicons.org/firebase" width="50px"/><br/>Firebase</td>
100+
<td align="center"><img src="https://cdn.simpleicons.org/cloudinary" width="50px"/><br/>Cloudinary</td>
101+
<td align="center"><img src="https://cdn.simpleicons.org/tensorflow" width="50px"/><br/>TensorFlow.js</td>
102+
</tr>
103+
</table>
104+
</div>
105+
106+
---
107+
108+
## 📱 Application Architecture
109+
110+
### System Architecture
111+
```
112+
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
113+
│ │ │ │ │ │
114+
│ User Mobile │◄────►│ FindIT API │◄────►│ NSFW Check │
115+
│ Application │ │ (Backend) │ │ │
116+
│ │ │ │ └─────────────────┘
117+
└─────────────────┘ └────────┬────────┘
118+
│
119+
▼
120+
┌─────────────────┐
121+
│ │
122+
│ MongoDB │
123+
│ Database │
124+
│ │
125+
└─────────────────┘
126+
```
127+
128+
### Mobile Architecture
129+
```
130+
131+
FindIT/
132+
├── Authentication
133+
│ └── Google Sign-In (VIT only)
134+
├── Item Feed
135+
│ └── Search Lost Item
136+
│ └── Claim Lost Item
137+
│ └── QR Code Scanner
138+
│ └── Secure Claiming
139+
├── Post Item
140+
│ └── Upload Details + Image (Report Found Item)
141+
│ └── Item Reported Successfully
142+
└── My Profile
143+
├── My Activity
144+
│ ├── My Claims (Claimed Item Details)
145+
│ └── My Reports (All Reported Items)
146+
│ └── List of Items Reported & Claimed
147+
│ └── Generate QR (For Secure Claiming)
148+
│ └── Delete Item
149+
├── Terms & Conditions
150+
├── Contact Us
151+
├── Developer Team
152+
└── Sign Out
153+
154+
155+
````
156+
157+
---
158+
159+
## ⚙️ Implementation Status
160+
161+
| Component | Status | Notes |
162+
|--------------------------|-----------------|------------------------------------------------------|
163+
| User Authentication | ✅ Complete | Google OAuth via Firebase (VIT Email only) |
164+
| Image Upload & Moderation| ✅ Complete | Cloudinary + NSFWJS |
165+
| Lost/Found Posting | ✅ Complete | Fully functional with filters |
166+
| QR Claim Flow | ✅ Complete | JWT-secured, time-limited QR claims |
167+
| My Items & Claims Page | ✅ Complete | Users can manage their history |
168+
| Admin Tools | ✅ Complete | Moderation & delete functionality |
169+
| App Core Features | ⏳ In Progress | Working version deployed, UI refinements ongoing |
170+
171+
---
172+
173+
## 🚀 Getting Started
174+
175+
### 📲 Download the App
176+
177+
You can **download the FindIT app** directly from our official website:
178+
🌐 [www.finditapp.me](https://www.finditapp.me)
179+
180+
Or, download the APK from our [**Initial Release**](https://github.com/your-org/findit-app/releases/tag/v1.0.0) GitHub release.
181+
182+
> 🔒 *VIT Google Sign-In is required to access the app.*
183+
184+
---
185+
186+
## 🔗 Related Repositories
187+
188+
- [FindIT Backend](https://github.com/pratham-developer/finditBackend)
189+
190+
## 👥 Meet Our Team
191+
192+
<div align="center">
193+
<table>
194+
<tr>
195+
<td align="center">
196+
<h3>Rudra Gupta</h3>
197+
<p><i>App & Website Developer</i></p>
198+
<a href="https://github.com/Rudragupta8777"><img src="https://img.shields.io/badge/GitHub-181717?style=flat-square&logo=github&logoColor=white" height="22" target="_blank"></a>
199+
<a href="https://www.linkedin.com/in/rudra-gupta-36827828b/"><img src="https://img.shields.io/badge/LinkedIn-0A66C2?style=flat-square&logo=linkedin&logoColor=white" height="22" target="_blank"></a>
200+
</td>
201+
<td align="center">
202+
<h3>Pratham Khanduja</h3>
203+
<p><i>App & Backend Developer</i></p>
204+
<a href="https://github.com/pratham-developer"><img src="https://img.shields.io/badge/GitHub-181717?style=flat-square&logo=github&logoColor=white" height="22" target="_blank"></a>
205+
<a href="https://www.linkedin.com/in/pratham-khanduja/"><img src="https://img.shields.io/badge/LinkedIn-0A66C2?style=flat-square&logo=linkedin&logoColor=white" height="22" target="_blank"></a>
206+
</td>
207+
</tr>
208+
</table>
209+
</div>
210+
211+
212+
<div align="center">
213+
<h3>
214+
<i>Lost & Found App</i> | Made with ❤️ by college students, for college students.</a>
215+
</h3>
216+
217+
---
218+
</div>

0 commit comments

Comments
 (0)