From 457004a0efe16f19105c6e22a364ae969ef7b571 Mon Sep 17 00:00:00 2001 From: Sicherhaven Date: Sat, 7 Mar 2026 12:15:28 +0530 Subject: [PATCH] docs: beautify README and add ASCII art --- README.md | 166 ++++++++++++++++++++++++------------------------------ 1 file changed, 73 insertions(+), 93 deletions(-) diff --git a/README.md b/README.md index 242627a..8c0b380 100644 --- a/README.md +++ b/README.md @@ -1,142 +1,122 @@ +```text + ███████╗██╗ ██╗███████╗███╗ ██╗████████╗██╗███████╗██╗ ██╗ + ██╔════╝██║ ██║██╔════╝████╗ ██║╚══██╔══╝██║██╔════╝╚██╗ ██╔╝ + █████╗ ██║ ██║█████╗ ██╔██╗ ██║ ██║ ██║█████╗ ╚████╔╝ + ██╔══╝ ╚██╗ ██╔╝██╔══╝ ██║╚██╗██║ ██║ ██║██╔══╝ ╚██╔╝ + ███████╗ ╚████╔╝ ███████╗██║ ╚████║ ██║ ██║██║ ██║ + ╚══════╝ ╚═══╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚═╝╚═╝ ╚═╝ + COMMAND CENTER +``` + # Eventify Command Center 🚀 ![Status](https://img.shields.io/badge/Status-Active-success) -![Version](https://img.shields.io/badge/Version-1.0.0-blue) -![Tech](https://img.shields.io/badge/Built%20With-Vite%20%7C%20React%20%7C%20Shadcn-purple) +![Version](https://img.shields.io/badge/Version-1.1.0-blue) +![Stack](https://img.shields.io/badge/Stack-React%20%7C%20Vite%20%7C%20Tailwind%204%20%7C%20Shadcn-purple) +![License](https://img.shields.io/badge/License-Proprietary-red) -The **Eventify Command Center** is the central administration dashboard for the Eventify platform. It provides sophisticated tools for User Management, Event Analytics, Support CRM, and Platform Moderation. Designed with a premium **Neumorphic** aesthetic, it serves as the cockpit for platform administrators. +The **Eventify Command Center** is the premium, high-performance administrative cockpit for the Eventify platform. Built with a sophisticated **Neobrutalism Lite** design language, it provides deep control over user management, event moderation, and platform feedback. --- -## 📸 Overview +## ✨ Primary Features -The Command Center is built to be an "Operating System for Events", offering high-density information displays and quick actions. +### 📨 Review Management (New!) +* **Inbox Zero Flow**: Moderate pending reviews with one-click Approve/Reject actions. +* **Smart Editing**: Edit review text in real-time via a smooth slide-over drawer with reviewer context. +* **Metrics Bar**: Live tracking of Pending (notification badges), Live, and Rejected counts. +* **Safety First**: Required reason selection for rejections and deletions to ensure audit trail integrity. -### Key Modules -- **User Management (CRM)**: comprehensive 360° view of users, bookings, and LTV. -- **Moderation Tools**: Suspensions, Bans, and "Refund Risk" analysis. -- **Notification System**: Push notifications and email communication to users. -- **Analytics Dashboard**: Real-time sales and engagement metrics. +### 👥 User Management (CRM) +* **360° Inspector**: Comprehensive view of user profiles, booking history, and platform activity. +* **Account Governance**: Suspend, Ban, or verify users with custom audit logging. +* **Smart Filtering**: Instant URL-based filtering for high-density user tables. + +### 📅 Event Presence +* **Global Events List**: Track and manage all hosted events. +* **Ad Control**: Integrated Sponsored Ads management for boosting platform visibility. + +### 📊 Real-time Monitoring +* **Premium Analytics**: High-level metrics for sales and user engagement. +* **Status Indicators**: Integrated platform uptime monitoring. --- -## 🏗 Architecture +## 🏗 High-Level Architecture -The application follows a **Feature-Based Architecture** ensuring scalability and maintainability. +The system utilizes a **Feature-Driven Architecture** decoupled from core pages for maximum modularity. ```mermaid graph TD - Client[Client UI (React/Vite)] -->|User Actions| Actions[Action Handlers] - Actions -->|Validate| Zod[Zod Schemas] - Actions -->|Execute| Service[Mock Backend Services] - Service -->|Log| Audit[Audit Logger] + UI[ECC Dashboard UI] -->|Nuqs State| URL[URL State Management] + UI -->|Actions| Lib[Lib / Features] + Lib -->|TypeScript| Types[Review/User Types] + Lib -->|Mock Data| Data[Mock Services] - subgraph UI Layer - Client - Components[Shadcn UI Components] + subgraph Design System + NB[Neobrutalism Lite] + NM[Neumorphic Utilities] end - subgraph Logic Layer - Actions - Hooks[Custom Hooks / Nuqs] - end - - subgraph Data Layer - Service - Types[TypeScript Interfaces] + subgraph Feature Modules + RM[Review Management] + UM[User Management] + AC[Ad Control] end ``` -### Tech Stack -- **Framework**: [Vite](https://vitejs.dev/) + React 18 -- **Language**: TypeScript -- **Styling**: [Tailwind CSS v4](https://tailwindcss.com/) -- **UI Components**: [Shadcn UI](https://ui.shadcn.com/) + Radix Primitives -- **State Management**: URL-based state with `nuqs` -- **Icons**: `lucide-react` -- **Validation**: `zod` +### Technical Specs +* **Framework**: [Vite](https://vitejs.dev/) + React 18 +* **Styling**: [Tailwind CSS v4](https://tailwindcss.com/) + Custom HSL Variables +* **Typography**: `Inter` (Body) + `Martian Mono` (Badges/Data) +* **State Management**: `nuqs` (Search Param Persistence) + React Context +* **Integrations**: `lucide-react` icons, `sonner` toasts, `radix-ui` primitives --- -## 🚀 Getting Started +## 🚀 Development & Deployment -### Prerequisites -- Node.js 18+ -- npm 9+ - -### Installation - -1. **Clone the repository** +### Local Setup +1. **Clone & Enter** ```bash git clone https://code.bshtech.net/Sicherhaven/eventify-command-center.git cd eventify-command-center ``` - -2. **Install dependencies** +2. **Initialize** ```bash npm install ``` - -3. **Run Development Server** +3. **Ignite** ```bash npm run dev ``` - Access the app at `http://localhost:8080` (or the port shown in terminal). ---- - -## 📂 Project Structure - -```text -src/ -├── features/ # Feature-based modules -│ └── users/ # User Management specific code -│ ├── components/ # UI Components (Inspector, Table, etc.) -│ └── data/ # Mock data and services -├── components/ # Shared global components (ui/ folders) -├── lib/ # Core utilities -│ ├── actions/ # Server-style actions (Action handlers) -│ ├── types/ # TypeScript definitions -│ └── utils.ts # Helper functions -├── pages/ # Main route pages -└── styles/ # Global CSS and Tailwind config -``` - ---- - -## 🛠 Deployment - -The application is deployed on the **Sicherh** infrastructure. - -- **Primary URL**: [https://admin.prototype.eventifyplus.com](https://admin.prototype.eventifyplus.com) -- **Server**: `sicherh` (Managed via SSH) -- **Process Manager**: PM2 - -### Deployment Command -To deploy the latest changes from `main`: +### Production Deployment (`sicherh`) +The application is hosted on our internal **Sicherh** infrastructure. ```bash -# SSH into the server +# Push latest changes +git push origin main + +# Update Production ssh sicherh - -# Navigate and Pull -cd eventify-command-center -git pull - -# Build and Restart -npm install +cd /root/eventify-command-center +git pull origin main npm run build -pm2 restart next-server +cp -rv dist/* /var/www/admin.prototype.eventifyplus.com/ ``` --- -## 🛡 Security & Permissions +## 📂 Design Tokens -- **Authentication**: Stubbed for prototype (Admin verification mocks). -- **Audit Logs**: All administrative actions (Ban, Suspend, Impersonate) are logged to the console/server logs via `lib/audit-logger.ts`. -- **RBAC**: Role-base access control logic is implemented in the `verifyAdmin` helper. +| Property | Value | Utility | +|----------|-------|---------| +| Primary | `#1E3A8A` | `bg-primary` | +| Accent | `#10B981` | `text-emerald-500` (Approval) | +| Feedback | `#EF4444` | `text-red-500` (Rejection) | +| Shadow | `3px 3px 0px 0px` | `shadow-neu` (Neobrutalism) | --- -> Built with ❤️ by **BSH Technologies** for the Eventify Platform. +> Built and Managed by **BSH Technologies** for the **Eventify Platform**.