Skip to content

Latest commit

 

History

History
139 lines (102 loc) · 3.06 KB

README.md

File metadata and controls

139 lines (102 loc) · 3.06 KB
Raw

SkillAegis-Dashboard

SkillAegis Logo

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) that can are designed by other application such as SkillAegis Editor.

Note

Consider running this application with SkillAegis for Production.

SkillAegis Dashboard Active Exercises 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.

SkillAegis Dashboard Active Exercises 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.

SkillAegis Dashboard Fullscreen 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:

  1. Ensure Python 3.10 or higher is installed. 
    python -V
  2. Install dependencies 
    python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
  3. Clone the configuration file 
    cp config.py.sample config.py
    • [optional] Update the configuration
  4. Start the application 
    # Usage: ./start.sh --exercise_folder <folder> [--host <host>] [--port <port>]
./start.sh --exercise_folder scenarios/

Development

Back-end

source venv/bin/activate
fastapi dev main.py

Front-end

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

Installation

# 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

python3 server.py
# Access the page http://localhost:4000 with your browser

Running the DEV setup

python3 server.py
npm run dev
# Access the page provided by the output of the above command

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Compile and Minify for Production

npm run build

Lint with ESLint

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