from pathlib import Path
readme = r'''
MissLost is a UEH-focused Lost & Found web platform that helps students post lost items, search for belongings, chat in real time, and support verified return activities through training-point integration.
MissLost is designed as a dedicated Lost & Found system for UEH students.
Instead of relying on scattered social media posts or manual announcements, the platform provides a centralized place where students can:
- Report lost items.
- Post found items.
- Search and filter item posts.
- Contact others through real-time messaging.
- Return items safely through a managed workflow.
- Connect verified return activities with the student training-point system.
The project is built with a modern full-stack architecture using Next.js, NestJS, PostgreSQL, and WebSocket.
Students can create posts for lost or found items with important details such as:
- Item name
- Description
- Category
- Location
- Time
- Images
- Contact status
This helps make item searching clearer, faster, and more organized.
MissLost supports real-time messaging using WebSocket, allowing users to quickly communicate when they find a matching item.
Use cases:
- A student finds a lost wallet and contacts the owner.
- The owner confirms item details privately.
- Both sides agree on a safe return location.
- Admins can monitor reports or suspicious activities if needed.
The system supports Gmail authentication and restricts access to UEH student accounts.
Allowed email domain: @ueh.edu.vn