updated and added more information to readme#101
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refreshes and expands the README to better reflect the current state of the project, including features, tech stack, testing instructions, and project status.
- Rewrites feature descriptions and reorganizes into clearer sections
- Adds detailed tech stack breakdown (frontend, backend, database/storage, tooling)
- Introduces a comprehensive Testing section and a Project Status & Development Progress section
- Minor cleanup of contributing link text
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - **Express Middleware** - Multer (file uploads), CORS, UUID generation | ||
|
|
||
| ### Database & Storage | ||
| - **Firebase** - Firestore (NoSQL database), Authentication, and data |
There was a problem hiding this comment.
Grammatical/clarity issue: 'and data' is incomplete and ambiguous. Recommend rephrasing to clearly state what Firebase provides.
| - **Firebase** - Firestore (NoSQL database), Authentication, and data | |
| - **Firebase** - Firestore (NoSQL database), Authentication, and Cloud Storage |
|
|
||
| > Note: PostgreSQL + PostGIS, Elasticsearch, AWS S3, and a JWT-based authentication backend are mentioned in earlier planning notes but are not implemented in this repository's current codebase — the project presently relies on Firebase for auth, data, and storage. These components remain possible future alternatives. | ||
| ### Backend | ||
| - **Node.js 16+ + Express 4.21.2** - JavaScript runtime and web framework |
There was a problem hiding this comment.
Node.js 16 is end-of-life; recommending it in documentation is not a best practice. Suggest updating to an active LTS baseline, e.g., 'Node.js 18+ (LTS)' to align with supported, secure runtimes.
| - **Node.js 16+ + Express 4.21.2** - JavaScript runtime and web framework | ||
| - **Firebase Admin 13.4.0** - Server-side Firebase SDK for admin operations | ||
| - **Cloudinary 2.7.0** - Cloud-based image and video management | ||
| - **Express Middleware** - Multer (file uploads), CORS, UUID generation |
There was a problem hiding this comment.
'UUID generation' (via the uuid package) is not middleware; grouping it under 'Express Middleware' is misleading. Consider rewording to separate middleware from utilities, e.g., '- Middleware: Multer, CORS; Utilities: uuid (ID generation)'.
| - **Express Middleware** - Multer (file uploads), CORS, UUID generation | |
| - **Express Middleware** - Multer (file uploads), CORS | |
| - **Utilities** - uuid (ID generation) |
| - 📰 **Item Feed**: Browse all reported lost and found items on campus | ||
| - 🔍 **Search & Filtering**: Search listings by type, location, and status | ||
| - 🗺️ **Interactive Maps**: View and select locations using Leaflet maps with coordinates | ||
| - 🧾 **User Profiles**: User profiles with lost/found item history and contact information |
There was a problem hiding this comment.
Redundant phrasing ('User Profiles: User profiles ...'). Consider tightening to avoid repetition, e.g., '- 🧾 User Profiles: Manage lost/found item history and contact information'.
| - 🧾 **User Profiles**: User profiles with lost/found item history and contact information | |
| - 🧾 **User Profiles**: Manage lost/found item history and contact information |
| - **React 18.3.1** - Modern React with hooks, routing (React Router DOM 6.30.1), and UI components (Lucide React 0.540.0) | ||
| - **Tailwind CSS 3.4.17** - Utility-first CSS framework for responsive design | ||
| - **Leaflet 1.9.4 + React Leaflet 4.2.1** - Interactive maps for location services | ||
| - **Firebase 12.0.0** - Client-side Firebase SDK for authentication and data |
There was a problem hiding this comment.
[nitpick] Hard-coding specific dependency versions in the README is prone to drift from package.json. Suggest omitting exact versions here or referencing the package.json/lockfile (or a 'Dependencies' badge) to keep docs accurate over time.
| - **Node.js 16+ + Express 4.21.2** - JavaScript runtime and web framework | ||
| - **Firebase Admin 13.4.0** - Server-side Firebase SDK for admin operations | ||
| - **Cloudinary 2.7.0** - Cloud-based image and video management |
There was a problem hiding this comment.
[nitpick] Similar to the frontend section, consider avoiding pinned versions in the README for backend dependencies to reduce maintenance overhead and prevent docs from becoming outdated.
| - **Node.js 16+ + Express 4.21.2** - JavaScript runtime and web framework | |
| - **Firebase Admin 13.4.0** - Server-side Firebase SDK for admin operations | |
| - **Cloudinary 2.7.0** - Cloud-based image and video management | |
| - **Node.js 16+ + Express** - JavaScript runtime and web framework | |
| - **Firebase Admin** - Server-side Firebase SDK for admin operations | |
| - **Cloudinary** - Cloud-based image and video management |
| - **Image Upload API**: The backend uses Cloudinary and Multer to handle secure image uploads. Images are uploaded from the frontend to the backend API, which processes them with Multer and stores them in Cloudinary. The resulting Cloudinary URLs are saved in Firestore and referenced in item listings. | ||
| - **CI/CD / Analysis / Security**: GitHub Actions, SonarLint/SonarCloud, and Snyk are listed as tooling that can be used for CI and quality checks. | ||
| ### Frontend | ||
| - **React 18.3.1** - Modern React with hooks, routing (React Router DOM 6.30.1), and UI components (Lucide React 0.540.0) |
There was a problem hiding this comment.
Use canonical npm package names for clarity and consistency (helps readers find packages). Suggest changing 'React Router DOM' to 'react-router-dom' and 'Lucide React' to 'lucide-react'.
| - **React 18.3.1** - Modern React with hooks, routing (React Router DOM 6.30.1), and UI components (Lucide React 0.540.0) | |
| - **React 18.3.1** - Modern React with hooks, routing (`react-router-dom` 6.30.1), and UI components (`lucide-react` 0.540.0) |
| - **Notification System** - Notification bell component and settings page | ||
| - **Campus Announcements** - Staff/admin announcement system | ||
| - **Responsive Design** - Mobile-first responsive interface | ||
| - **Testing** - Test suite across 10 major components |
There was a problem hiding this comment.
[nitpick] This statement appears duplicated in both 'Completed Features' and 'Development Metrics'. Consider removing one or rephrasing to avoid repetition.
| - **Testing** - Test suite across 10 major components | |
| - **Testing** - Comprehensive test suite implemented |
| - **Code Quality** - SonarQube analysis applied with documented improvements | ||
|
|
||
| ### Development Metrics 📈 | ||
| - **Test Coverage**: Test suite across 10 major components |
There was a problem hiding this comment.
[nitpick] This statement appears duplicated in both 'Completed Features' and 'Development Metrics'. Consider removing one or rephrasing to avoid repetition.
| - **Test Coverage**: Test suite across 10 major components | |
| - **Test Coverage**: High coverage across all major components |
ntur101
left a comment
ntur101
left a comment
There was a problem hiding this comment.
Looks good, love the updates, do you think you could maybe just update the "Major contributors:" to add us into it as well? currently only has the old group so think it would be great if you could quickly add us. If possible maybe also change it so the dependency versions are not hard coded - eg just "React" instead of "React 18.3.1" - just means if theres an update we don't have to continually update the readme! Otherwise looking good :)
|
mkee115
left a comment
mkee115
left a comment
There was a problem hiding this comment.
Looks good! the updates are a lot better! Good that it now has our names and UPIs included.
|
All further requests were done and it reads well. Thanks looks good. |
📌 Description
This PR updates the README so that it isn't outdated
We need to update the README so that when people first encounter this repository, they are able to get the correct knowledge of the project.
Please include a summary of the changes and the related issue. Provide context for reviewers.
🔗 Related Issue(s)
Closes #100
✅ Changes
Updated the README while also adding some information where needed