An open API service indexing awesome lists of open source software.

https://github.com/paralisieth/project02


https://github.com/paralisieth/project02

ctf-platform cyber-labs cybersecurity cybersecurity-education devsecops fastapi infosec jwt-authentication penetration-testing postgresql python react security-automation security-tools security-training training-platform typescript virtual-machines virtualbox vm-management

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

![Cyber Training Platform](https://img.shields.io/badge/Project-Cyber%20Training%20Platform-blue)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)
[![Stars](https://img.shields.io/github/stars/paralisieth/Project02?style=social)](https://github.com/paralisieth/Project02/stargazers)
[![Forks](https://img.shields.io/github/forks/paralisieth/Project02?style=social)](https://github.com/paralisieth/Project02/network/members)

# ๐Ÿ›ก๏ธ Cyber Training Platform

> A comprehensive platform for cybersecurity training, featuring isolated lab environments and virtual machine management. Perfect for educational institutions, cybersecurity professionals, and organizations conducting security training.


Platform Preview

## โœจ Key Features

๐Ÿ”’ **Secure Lab Environments**
- Isolated networking for safe exploit practice
- Pre-configured security lab templates
- Multi-VM scenario support

๐Ÿ–ฅ๏ธ **Advanced VM Management**
- Create and manage virtual machines with ease
- Real-time VM status monitoring
- Secure remote access (RDP/SSH)

๐Ÿ‘ฅ **User Management**
- Role-based access control
- Progress tracking
- Team collaboration features

๐Ÿ” **Enterprise-Grade Security**
- JWT-based authentication
- Network isolation
- Secure remote connections

## ๐Ÿš€ Quick Start

### Prerequisites
- Python 3.7+
- VirtualBox 7.0+
- 8GB+ RAM
- 50GB+ free disk space
- Windows/Linux host OS

### One-Click Installation
```bash
# Clone the repository
git clone https://github.com/your-username/cyber-training-platform.git

# Run the setup script
./setup.sh # Linux/Mac
# or
setup.bat # Windows
```

For detailed setup instructions, see our [Installation Guide](./docs/deployment.md).

## ๐Ÿ“š Documentation

- [API Documentation](./docs/api.md)
- [Architecture Overview](./docs/architecture.md)
- [Development Guide](./docs/development.md)
- [Deployment Guide](./docs/deployment.md)
- [Security Guide](./docs/security.md)

## ๐Ÿค Contributing

We welcome contributions! See our [Contributing Guide](./CONTRIBUTING.md) for details.

### Contributors


## ๐Ÿ“ License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## ๐ŸŒŸ Show your support

Give a โญ๏ธ if this project helped you!

## ๐Ÿ“Š Project Stats

![GitHub Activity](https://img.shields.io/github/commit-activity/m/paralisieth/Project02)
![GitHub Issues](https://img.shields.io/github/issues/paralisieth/Project02)
![GitHub Pull Requests](https://img.shields.io/github/issues-pr/paralisieth/Project02)

## ๐Ÿ”— Links

- [Website](https://your-project-website.com)
- [Documentation](https://your-docs-site.com)
- [Bug Reports](https://github.com/paralisieth/Project02/issues)
- [Feature Requests](https://github.com/paralisieth/Project02/issues/new)

## ๐Ÿ— Project Structure

```
backend/
โ”œโ”€โ”€ app/
โ”‚ โ”œโ”€โ”€ api/
โ”‚ โ”‚ โ””โ”€โ”€ routes/ # API endpoints
โ”‚ โ”œโ”€โ”€ core/ # Core functionality
โ”‚ โ””โ”€โ”€ services/ # Business logic
โ”œโ”€โ”€ tests/ # Test cases
โ””โ”€โ”€ scripts/ # Utility scripts
```

## ๐Ÿ“ฆ Installation

1. **Set up Python environment**
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
pip install -r requirements.txt
```

2. **Configure environment**
```bash
cp .env.example .env
# Edit .env with your settings
```

3. **Install VirtualBox**
```bash
# Windows
./scripts/install_virtualbox.bat

# Linux
./scripts/install_virtualbox.sh
```

## ๐Ÿš€ Quick Start

1. **Start the backend**
```bash
python -m uvicorn app.main:app --reload
```

2. **Create your first lab**
```bash
# Get auth token
curl -X POST http://localhost:8000/api/auth/token -d "username=admin&password=admin123"

# Create a lab
curl -X POST http://localhost:8000/api/labs -H "Authorization: Bearer YOUR_TOKEN"
```

## ๐Ÿงช Testing

```bash
pytest
pytest --cov=app tests/
```

## ๐Ÿ”’ Security

- Change default credentials in production
- Use HTTPS in production
- Follow security guidelines in [Security Guide](./docs/security.md)

## ๐Ÿ—บ Roadmap

See [ROADMAP.md](ROADMAP.md) for planned features and development timeline.