https://github.com/misp/skillaegis-dashboard
SkillAegis-Dashboard is a platform to run a training session and visualize the progress of participants in real-time. Part of SkillAegis.
https://github.com/misp/skillaegis-dashboard
Last synced: 9 months ago
JSON representation
SkillAegis-Dashboard is a platform to run a training session and visualize the progress of participants in real-time. Part of SkillAegis.
- Host: GitHub
- URL: https://github.com/misp/skillaegis-dashboard
- Owner: MISP
- License: agpl-3.0
- Created: 2024-07-25T11:50:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-21T09:22:46.000Z (10 months ago)
- Last Synced: 2025-08-21T10:45:06.077Z (10 months ago)
- Language: Python
- Homepage:
- Size: 17 MB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SkillAegis-Dashboard
**SkillAegis-Dashboard** is a platform to run a training session and visualize the progress of participants in real-time.
The Dashboard allows you to deploy and run scenarios under the [Common Exercise Format (CEXF)](https://misp.github.io/cexf/) that can are designed by other application such as **[SkillAegis Editor](https://github.com/MISP/SkillAegis-Editor)**.
> [!NOTE]
> Consider running this application with **[SkillAegis](https://github.com/MISP/SkillAegis)** for Production.
*Short demo of SkillAegis-Dashboard: Once the application starts, the user selects an exercise. From that point, the application tracks the real-time progression of each players.*
*On the dashboard main page, you can monitor the progress of all participants for the selected exercise and view real-time logs of their activity feed.*
*The fullscreen view provides an overview of the status of all users in a single, easily accessible display.*
## Installation
To get started with SkillAegis-Editor, follow these steps:
0. Ensure Python **3.10** or higher is installed.
```bash
python -V
```
1. Install dependencies
```bash
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
```
2. Clone the configuration file
```bash
cp config.py.sample config.py
```
- [optional] Update the configuration
3. Start the application
```bash
# Usage: ./start.sh --exercise_folder [--host ] [--port ]
./start.sh --exercise_folder scenarios/
```
## Development
### Back-end
```bash
source venv/bin/activate
fastapi dev main.py
```
### Front-end
#### Project Setup
```sh
npm install
```
#### Compile and Hot-Reload for Development
```sh
npm run dev
```
#### Compile and Minify for Production
```sh
npm run build
```
#### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```
## Installation
```bash
# Setup venv
python3 -m venv venv
source venv/bin/activate
# Install deps
pip3 install -r REQUIREMENTS
# Create config file and adapt it to your needs
cp config.py.sample config.py
```
## Running the PROD setup
```bash
python3 server.py
# Access the page http://localhost:4000 with your browser
```
## Running the DEV setup
```bash
python3 server.py
```
```bash
npm run dev
# Access the page provided by the output of the above command
```
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Compile and Minify for Production
```sh
npm run build
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```
# License
This software is licensed under GNU Affero General Public License version 3
```
Copyright (c) 2024 Sami Mokaddem
Copyright (c) 2024 CIRCL - Computer Incident Response Center Luxembourg
```