admin-panel

The adminPanel module provides an administrator-facing dashboard for the Zumito platform, allowing bot owners and staff to configure bot settings, oversee servers, and manage platform operations through a secure control interface with role-based access and real-time monitoring.

Features

• Admin Dashboard: Centralized overview of bot status, server statistics, and platform metrics.

• Bot Configuration: Tools to adjust global bot settings, features, and integrations.

• Server Oversight: View and manage servers where the bot is active, with moderation and control options.

• Role-Based Permissions: Access levels for different administrator roles, ensuring secure management.

• Authentication: Integrated authentication system with session handling for admins.

• Real-Time Monitoring: Live metrics and logs to track bot performance and events.

• Views: Uses EJS templates for a dynamic and responsive administrator UI.

Installation

This module is part of the Zumito ecosystem. To use it, ensure you have zumito-framework installed in your project.

npm install @zumito-team/admin-panel-module

Usage

To integrate the adminPanel module into your Zumito application, instantiate and register it with your main ZumitoFramework:

import { ZumitoFramework } from "zumito-framework";
import { AdminPanelModule } from "@zumito-team/admin-panel-module";

new ZumitoFramework({
    // ... other options
    bundles: [{
        path: path.join(__dirname, "node_modules", "@zumito-team", "admin-panel-module"),
    }]
    // Other options
})

The module will automatically register its services and routes.

Key Services

• AdminNavigationService: Manages navigation elements specific to the admin panel.

• AdminViewService: Responsible for rendering administrator panel views.

Routes

Main routes exposed by this module include:

• /admin: Main administrator dashboard.

• /admin/servers: Manage and oversee bot servers.

• /admin/config: Configure global bot settings.

• /admin/login: Admin login page.

• /admin/login/callback: Authentication callback.

• /admin/logs: Access real-time logs and performance data.