OpenAuditLabs Web Dashboard

Welcome to the OpenAuditLabs Web Dashboard repository. This project serves as the primary user interface for interacting with OpenAuditLabs, providing a comprehensive dashboard to visualize, manage, and analyze your audit data in a user-friendly environment.

Table of Contents

• Overview
• Features
• Getting Started
• Usage
• Contributing
• License
• Contact

Overview

The OpenAuditLabs Web Dashboard is designed to be the central hub for users to interact with audit data collected by OpenAuditLabs. It consolidates critical information and presents it through intuitive visualizations, enabling users to efficiently monitor audit status, review device breakdowns, and access key metrics relevant to their organization.

Features

• Centralized Audit Overview: View the status of all ongoing and completed audits from a single dashboard.
• Device Management: Analyze device breakdowns, identify new software installs, and monitor missing or unresponsive devices.
• Customizable Widgets: Tailor the dashboard to display the most relevant charts and metrics for your needs.
• User Access Control: Secure dashboard access with user authentication and role-based permissions.
• Real-Time Updates: Receive up-to-date information as audit data is collected and processed.
• Export and Reporting: Generate and download reports for further analysis or compliance purposes.

Getting Started

Prerequisites

• Node.js (version 18.X or higher)
• npm
• Access to an OpenAuditLabs backend instance

Installation

1. Clone the Repository:

   git clone https://github.com/openauditlabs/web.git
   cd web

2. Install Dependencies:

   npm install

3. Configure Environment:

   • Copy .env.example to .env and update configuration variables as needed.
   • Set IRON_SESSION_PASSWORD to a long, random string (32+ characters) used to encrypt the session cookie.

4. Start the Development Server:

   npm run dev

Usage

Once the application is running, access the dashboard via your web browser at http://localhost:3000 (or the configured port). Log in using your credentials to access personalized dashboards and audit data.

• Dashboard: View audit summaries, device statuses, and actionable insights.
• Reports: Generate and export audit reports.
• Settings: Manage user profiles and dashboard preferences.

Contributing

We welcome contributions to improve the dashboard! Please read our CONTRIBUTING.md for guidelines on submitting issues, feature requests, and pull requests.

License

This project is licensed under the GNU Affero General Public License v3 (AGPLv3) - see the LICENSE file for details.

Contact

For questions, support, or feedback, please contact the OpenAuditLabs team at [email protected].

OpenAuditLabs - Securing the Future of Smart Contracts with AI