This is a web application for integrated lost and found management at Sejong University. It provides map-based lost item registration/search, real-time chat, and an administrator approval system.
Project Website: https://jin040907.github.io/UniLost/
Visit our Jekyll-powered website for an overview of the project, features, community information, and more.
Deployed Website: https://unilost.onrender.com
⚠️ Render's free plan enters sleep mode after 15 minutes of inactivity. There may be a slight delay when accessing it for the first time.
Full Documentation: https://unilost.readthedocs.io/
Comprehensive documentation including installation guides, API reference, configuration options, and more is available on Read the Docs.
- 🗺️ Map-based Lost and Found Registration/Search: Location-based lost and found management using Leaflet maps
- 💬 Real-time Chat: Socket.IO-based global chat and item-specific threaded chat
- 👤 User Authentication: Session-based login/logout system
- 🔐 Administrator Functions: Lost and found approval/rejection, storage location management
- 💾 Permanent Data Storage: Data preservation via PostgreSQL (production) / SQLite (local development) database
- 📱 Responsive Design: Supports both mobile and desktop
- Backend: Node.js, Express.js
- Database: PostgreSQL (production) / SQLite (local development)
- Real-time: Socket.IO
- Frontend: HTML, JavaScript, Tailwind CSS
- Maps: Leaflet.js, OpenStreetMap
- Documentation: Sphinx (Read the Docs), Jekyll (GitHub Pages)
Server:
- Node.js 18.0.0 or later (recommended: Node.js 20 LTS)
- npm 9.0.0 or later
- PostgreSQL (for deployment) or SQLite (for local development)
Client:
- Modern web browsers (Chrome 90+, Firefox 88+, Safari 14+, Edge 90+)
- Mobile: iOS Safari 14+, Android Chrome 90+
For detailed documentation, see the Full Documentation.
# Clone the repository
git clone https://github.com/jin040907/UniLost.git
cd UniLost
# Install dependencies
npm install# Start the server
npm start
# or
node server.jsOnce the server is running, you can access it at http://localhost:3000.
- Student Accounts:
student1~student10/1234 - Administrator Accounts:
admin1~admin10/admin123
.
├── .github/ # GitHub configuration
│ ├── ISSUE_TEMPLATE/ # Issue templates
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ └── workflows/ # GitHub Actions workflows
│ └── pages.yml # GitHub Pages deployment
│
├── app/ # Application source code
│ ├── server.js # Express server main file
│ ├── db.js # PostgreSQL/SQLite database module
│ ├── unilost.html # Frontend HTML file (main application)
│ ├── unilost.db # SQLite database file (local development)
│ └── utils/ # Utility modules
│ └── errorHandler.js # Error handling utilities
│
├── assets/ # Project assets (images, etc.)
│
├── scripts/ # Utility scripts
│ ├── add-dummy-data.js # Add sample data to database
│ ├── update-user-names.js # Update user names
│ ├── update-item-locations.js # Update item locations
│ └── utils/ # Utility scripts
│ └── check-critical-functions.sh
│
├── docs/ # Documentation (Sphinx)
│ ├── source/ # Sphinx source files (.rst)
│ ├── build/ # Sphinx build output (gitignored)
│ ├── Makefile # Sphinx build commands (Unix)
│ ├── make.bat # Sphinx build commands (Windows)
│ └── requirements.txt # Python dependencies for Sphinx
│
├── website/ # Jekyll Website (GitHub Pages)
│ ├── _config.yml # Jekyll configuration
│ ├── Gemfile # Ruby dependencies for Jekyll
│ ├── index.md # Homepage
│ ├── features.md # Features page
│ ├── community.md # Community page
│ ├── contact.md # Contact page
│ ├── _layouts/ # Jekyll layouts
│ │ └── default.html
│ ├── _includes/ # Jekyll includes
│ │ ├── header.html
│ │ └── footer.html
│ └── assets/ # CSS and JavaScript assets
│ ├── css/
│ │ └── main.css
│ └── js/
│ └── main.js
│
├── guidelines/ # Project guidelines and documentation
│ ├── APACHE_LICENSE_COMPLIANCE.md
│ ├── CHECKLIST.md
│ ├── COMPATIBILITY.md
│ ├── DATABASE_SETUP.md
│ ├── DEPLOY.md
│ ├── PROJECT_STRUCTURE.md
│ └── UniLost_Deliverable.docx
│
├── server.js # Entry point (runs app/server.js)
├── package.json # Node.js dependencies
├── package-lock.json # NPM lock file
├── render.yaml # Render deployment configuration
├── _config.yml # Jekyll configuration (root, for reference)
├── .readthedocs.yaml # Read the Docs configuration
├── .gitignore # Git ignore rules
├── LICENSE # Apache License 2.0
├── README.md # Project documentation
├── SECURITY.md # Security policy
├── CODE_OF_CONDUCT.md # Code of conduct
└── CONTRIBUTING.md # Contribution guidelines
GET /api/me- Currently logged in user informationPOST /api/login- LoginPOST /api/logout- Logout
GET /api/items- Retrieve all items (query:?status=pending|approved)GET /api/items/:id- Retrieve a specific itemPOST /api/items- Register an item (login required)PATCH /api/items/:id- Edit an item (admin only)DELETE /api/items/:id- Delete an item (admin only)
chat:join- Join a global chatchat:send- Send a global chat messagethread:join- Join a thread for each itemthread:send- Send a thread message
- users: User information
- items: Lost and Found items
- chat_messages: Global chat messages
- thread_messages: Threaded messages for each item
Current Deployment Status: ✅ https://unilost.onrender.com
For deployment instructions, see the Deployment Guide in the documentation.
- Upload your code to GitHub
- Select "New Web Service" in Render
- Connect your GitHub repository
- Automatic deployment complete!
- URL: https://unilost.onrender.com
- Hosting: Render (Free Plan)
- Database: PostgreSQL (if DATABASE_URL is set) or SQLite (default)
PORT: Server port (default: 3000)SESSION_SECRET: Session secret key (required for production environments)DATABASE_URL: PostgreSQL connection string (required for deployment)- Example:
postgresql://user:password@host:5432/database - If not available, use SQLite for local development.
- Google Groups: Join our mailing list or email unilost@googlegroups.com
- GitHub Discussions: Join discussions
- GitHub Issues: Report issues
- Project Website: Visit our website
- Documentation: Read the docs
Apache License 2.0
For details, refer to the LICENSE file.
Sejong University Open Source Software Introduction Project