🛡️ Cyber Assistant – Real-Time Security Dashboard

---

Overview

Cyber Assistant is an AI-powered security dashboard designed to help users monitor, manage, and improve their cybersecurity posture in real-time. Built using Next.js, React, TailwindCSS, and PostgreSQL, it combines dynamic threat monitoring, personalized task management, and an interactive AI assistant to offer a complete digital protection suite.

---

Table of Contents

• Key Features
• Architecture
• Workflow
• Getting Started
• Installation
• Usage
• Project Structure
• API Endpoints
• Technologies Used
• Contributing
• License

---

Key Features

• Real-Time Security Scoring: Instantly assess and visualize your cybersecurity posture.
• Threat Monitoring: Receive dynamic alerts about potential vulnerabilities and threats.
• Security Task Management: Organize and prioritize tasks to improve security systematically.
• Interactive AI Chat Assistant: Get AI-driven personalized advice to strengthen security settings.
• Secure User Authentication: Robust authentication with Email/Password and Two-Factor Authentication (2FA).

---

Architecture

The system architecture is composed of:

• Frontend: Responsive dashboard using Next.js and React.
• Backend: RESTful API built with Node.js, serving security assessments, alerts, and task management.
• Database: PostgreSQL database for storing user data, tasks, and security reports.
• AI Integration: OpenAI-powered chat assistant providing live cybersecurity recommendations.

---

Workflow

1. Authentication: Users sign up/login securely with 2FA.
2. Security Assessment: Dynamic security scoring based on user settings and habits.
3. Alerts and Notifications: Real-time detection of vulnerabilities and breaches.
4. Task Management: Actionable task lists to systematically improve user security.
5. AI Interaction: Live AI chat providing personalized cybersecurity advice.

---

Getting Started

Installation

1. Clone the Repository

git clone https://github.com/stuhamz/Cyber-Assistant.git
cd Cyber-Assistant

2. Install Dependencies

npm install
# or
yarn install

3. Set up Environment Variables

Create a .env.local file:

DATABASE_URL=your_database_url
NEXT_PUBLIC_API_URL=http://localhost:3000/api

4. Run the Development Server

npm run dev
# or
yarn dev

5. Access the App

Visit: http://localhost:3000

---

Usage

• Sign In: Create an account or log in securely.
• Dashboard: Monitor your real-time security score, alerts, and pending tasks.
• Chat Assistant: Ask security-related questions to the AI assistant for instant recommendations.

---

Project Structure

Cyber-Assistant/
├── src/
│   ├── api/ (API routes)
│   ├── app/ (Frontend pages and components)
│   ├── assets/ (Images and Icons)
│   ├── utilities/ (Helper functions)
│   └── styles/ (Global and component-specific styles)
├── package.json
├── next.config.js
├── tailwind.config.js
├── .gitignore
└── README.md

API Routes

• GET /api/security-assessment
• POST /api/security-assessment
• GET /api/security-alerts
• POST /api/security-alerts
• GET /api/security-tasks
• POST /api/security-tasks

Frontend Pages

• Dashboard (Security Metrics, Alerts, Tasks)
• Landing Page
• Chat Assistant Interface
• Readme Page

---

Technologies Used

• Next.js - Fullstack React Framework
• React.js - Frontend Library
• TailwindCSS - Utility-first CSS Styling
• Node.js - Server-side JavaScript runtime
• PostgreSQL - Relational Database
• OpenAI API - AI chat assistant
• Docker (optional for deployment)

---

Contributing

We welcome contributions! 🚀

• Fork the repository
• Create a feature branch
• Submit a pull request

---

License

This project is licensed under the MIT License.

---