security-c4po/README.md

Welcome to the frontend repository of Security C4PO, an open-source pentest reporting tool. Security C4PO is a powerful, user-friendly tool designed to simplify the process of generating professional pentest reports. It aims to streamline and automate the often time-consuming task of creating comprehensive reports by providing an intuitive web-based interface that facilitates the content of the OWASP TESTING GUIDE.

This repository contains the codebase of Security C4PO, built with an Angular Frontend and two Spring Boot Backend Microservices.

Table of Contents

• Application Architecture
• Data Structure
• C4PO Roadmap
• Project
  • Technical Requirements
  • Tools
  • Conventions
  • Development server
  • Testuser Credentials
• Contributing
• License

Application Architecture

Data Structure

C4PO Roadmap

Project

Technical Requirements

• Docker / Docker-compose
• OpenJDK 11
• Node 14.15.1 / npm 6.14.8
• MongoDB 4.4.6

Tools

• mongoDB Compass
• Postman
• Jaspersoft Studio

Conventions

• Branch: <initial>_c4po_<issuenumber>
• Commit: feat: <What was implemented?> or fix: <What got fixed?>

Development server

Execute 'c4po.sh' and all services will run on a dev server.

Testuser Credentials

• Username: c4po
• Password: Test1234!

Contributing

Contributions to Security C4PO are welcome! If you'd like to contribute to the project, please follow the guidelines outlined in the CONTRIBUTING.md file.

License

Security C4PO is licensed under the Apache License 2.0 License. Please see the LICENSE file for more information.

We hope you find Security C4PO useful for managing and generating pentest reports. If you encounter any issues or have suggestions for improvement, please feel free to create an issue on the issue tracker.