CheQup is a comprehensive web application designed to provide real-time network safety surveillance and monitoring across a wide range of IP devices. It offers features such as live streaming, recording, remote device control, and automated alerts triggered by various events. CheQup aims to deliver a seamless, secure, and efficient user experience across multiple platforms.
Table of Contents
Features
Tech Stack
Installation
Usage
Directory Structure
Contributing
License
Features
CheQup includes the following key features:
User Authentication and Authorization: Secure user access and role-based permissions.
Device Linking and Management: Connect and manage IP devices seamlessly.
Real-Time Network Safety Surveillance: Monitor network safety in real-time.
Live Streaming and Recording: Stream live footage and record events.
Remote Device Control: Control connected devices remotely.
Automated Alerts and Triggers: Receive alerts based on predefined triggers.
Location Tracking and GPS: Track device locations using GPS technology.
Integration with Third-Party Applications: Seamlessly integrate with third-party apps like WhatsApp, WeChat, SnapChat and Facebook.
Secure Communication and Data Handling: Ensure secure communication and data handling protocols.
Tech Stack
Frontend
React.js: JavaScript library for building user interfaces.
Next.js: React framework for server-rendered applications.
SuperTokens: Authentication library for secure user authentication.
WebRTC: Real-Time Communication protocol for web applications.
Socket.io: Library for real-time web applications enabling bidirectional communication.
Backend
NestJS: Node.js framework for building efficient, reliable, and scalable server-side applications.
PostgreSQL: Open-source relational database management system.
Docker: Platform for developing, shipping, and running applications in containers.
Kubernetes: Container orchestration platform for automating deployment, scaling, and management of containerized applications.
Wazuh: Security monitoring and threat detection platform.
Grafana: Open-source analytics and monitoring solution for every database.
Twilio: Cloud communications platform for building SMS, Voice & Messaging applications.
Installation
Prerequisites:
Node.js
Docker and Docker Compose
Steps
Clone the repository:
sh
git clone https://github.com/yourusername/chequp.git
cd chequp
Install frontend dependencies:
sh
cd frontend
npm install
Install backend dependencies:
sh
cd ../backend
npm install
Set up environment variables:
Create a .env file in both frontend and backend directories and add the necessary environment variables.
Start the backend using Docker:
sh
docker-compose up --build
Start the frontend:
sh
cd ../frontend
npm run dev
Usage
Open your browser and navigate to:
plaintext
http://localhost:3000
Register or log in to your account.
Link your devices and start exploring the features of CheQup.
Directory Structure
sql
chequp/
|-- frontend/
| |-- components/
| |-- pages/
| |-- public/
| |-- styles/
| |-- .env
| |-- next.config.js
| |-- package.json
| |-- README.md
|
|-- backend/
| |-- src/
| |-- .env
| |-- Dockerfile
| |-- docker-compose.yml
| |-- package.json
| |-- README.md
|
|-- .gitignore
|-- README.md
We welcome contributions from the community! To get started, please fork the repository, create a new branch for your feature or bug fix, and submit a pull request.
This project is licensed under the MIT License.