Cleansy

Welcome to our Community Management System repository! This project is a sophisticated web application built on the MERN stack (MongoDB, Express.js, React.js, Node.js). It includes various features aimed at streamlining community interactions and enhancing user experience.

Table of Contents

• Installation
• Technologies
• Features
• System Overview
• System Architecture
• Team

Installation

To set up the project locally, follow these steps:

1. Clone the repository:

git clone https://github.com/samidisjg/Cleansy.git

2. Install dependencies for the frontend and backend:

Cleansy> cd frontend
Cleansy\frontend> npm install

Cleansy> npm install

3. Set up MongoDB:

• Create a MongoDB database and configure the connection in backend/server.js.

4. Run the development server:

Cleansy> cd frontend
Cleansy\frontend> npm run dev

Cleansy> npm run dev

Cleansy> cd socket
Cleansy\socket> npm run dev

Cleansy> cd faceRecognition
Cleansy\faceRecognition> python -u "\Cleansy\faceRecognition\attendance2.py"

• backend Server running http://localhost:3000 in your browser.
• socket Server running http://localhost:4000 in your browser.

Technologies

• Node.js
• React.js
• Express.js
• MongoDB
• Python
• Redux
• Firebase
• Socket.io
• Tailwind CSS
• Flowbite React - UI
• NPM

Features

• OAuth for User Management: Securely manage user authentication and authorization with OAuth integration.
• Real-time chat for instant communication among community members.
• QR services for simplified access to resources and payments.
• Python-powered face recognition for enhanced security measures and personalized experiences in staff management.
• Algorithmic-based bookings in amenities (Time based) , service requesting in status based.
• Automated email notifications to keep stakeholders informed and engaged.
• cart checkout feature in the shared resource marketplace, Stripe Payment Gateway Integration with Securely process payments.
• Mini-games for added interaction and engagement within the community.
• Real-time comment likes on the marketplace for instant feedback.
• Dynamic ratings in workgroups for enhanced collaboration and feedback.
• Category and time based Community announcements platform.
• parking slot reservation capability using a QR code.
• Search and Filter Options: Easily find and filter content based on specific criteria.
• Report Generating Option: Generate detailed reports for insights and analysis.
• CRUD Operations: Seamlessly manage data with Create, Read, Update, and Delete operations.

System Overview

All the community management services are centralized through our sustainable community management system to provide a smooth and user friendly experiences to the all the community members and authorities.

System Architecture

All core functionalities of our system are developed using the MERN (MongoDB, Express.js, React.js, Node.js) stack, ensuring robustness and scalability. Google authentication is integrated for enhanced security, while Redux facilitates smooth state management for an optimal user experience. Moreover, our system is fully integrated with GitHub for seamless collaboration and version control. We aim to deploy the entire system on servers using technologies like Docker for efficient containerization and management.

Team

• Gamage S S J (Lead) https://github.com/samidisjg
• Nimes R H R https://github.com/ramindu-Nimex
• Damnidu T W T https://github.com/Thewa-AlienHub
• P Pradicksha https://github.com/Pradi-Hub
• Dissanayake D M T V https://github.com/Tommy14
• Gunawardena T S https://github.com/thihansi
• U U M Hewage https://github.com/U-WarlockX
• Hettiarachchi D S W https://github.com/Dinethra2001

Copyright

© 2024 Cleansy. All rights reserved.