README.md

SecureLearning

Strengthening organizations through cybersecurity awareness.
Explore our sites »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

SecureLearning is a cybersecurity awareness platform designed to strengthen organizational resilience by addressing the human element of security. It enables teams to run realistic, periodic phishing simulations and deliver targeted, just-in-time training based on real user behaviour.

The platform closes the loop between attack simulation, instant remediation, and measurable learning outcomes, giving security teams actionable insights into user susceptibility and improvement over time.

Key capabilities include a campaign designer and scheduler, a safe and isolated phishing simulation engine, automated video-based training with short exams, remediation workflows triggered immediately after risky actions, and audit-ready reporting dashboards

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Step by step on how to start development

Prerequisites

From Core directory:

• npm

  cd web
  npm install

• If uv not installed

  curl -LsSf https://astral.sh/uv/install.sh | sh

Default Values

Both compose files use these defaults:

POSTGRES_USER=myuser
POSTGRES_PASSWORD=mypassword
POSTGRES_DB=mydatabase
POSTGRES_SERVER=db
POSTGRES_PORT=5432

Override with .env File

Create a .env file in the deployment/ directory:

# Database Configuration
POSTGRES_USER=myuser
POSTGRES_PASSWORD=mypassword
POSTGRES_DB=mydatabase

And another .env file in the api/ directory:

POSTGRES_USER=myuser
POSTGRES_PASSWORD=mypassword
POSTGRES_SERVER=localhost
POSTGRES_PORT=5432
POSTGRES_DB=mydatabase

Development

To develop locally:

Launch a terminal in /Core

   cd web
   npm run dev

In a second terminal:

# Start PostgreSQL only
cd deployment
docker compose -f docker-compose.dev.yml up -d

Then run api

cd..
cd /api uv run fastapi dev src/main.py

Installation

To define...

...

(back to top)

Usage

To define...

(back to top)

Roadmap

Current (Q1)	Next (Q2)	Future (Q3–Q4)
🔹 Authentication (FastAPI + Keycloak)	🔸 Phishing Campaign Builder	🟢 Machine-learning-based risk scoring
🔹 User Dashboard (React + Vite)	🔸 Role-based Access + Org Units	🟢 SOC integration (SIEM export)
🔹 Dockerized Dev Environment	🔸 RabbitMQ Message Pipelines	🟢 Mobile-friendly redesign
🔹 Basic Reporting	🔸 Nginx Production Deployment	🟢 Plugin marketplace
🔹 CI/CD Pipeline Setup	🔸 Advanced Analytics	🟢 Multi-tenant SaaS mode

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

Not available while private...

License

To define...

(back to top)

Contact

Project Link: https://github.com/PEI-SecureLearning/core

(back to top)

Acknowledgments

Thinking about it...