diff --git a/reports/README.md b/reports/README.md new file mode 100644 index 00000000..a785a948 --- /dev/null +++ b/reports/README.md @@ -0,0 +1,18 @@ +# Security Audit Reports + +## Purpose +This directory contains security audit reports that evaluate the OnTrack API and Web against the OWASP Top 10 vulnerabilities for 2021. These reports are designed to help developers, architects, and managers understand the security posture of the project and address potential risks. + +## Contents +1. **`Security-Audit-OWASP-Top-10-Results-localhost-API-02122024.pdf`** + - **Description**: Details the OWASP Top 10 compliance results for the OnTrack API hosted locally at `http://localhost:3000`. + - **Key Highlights**: Identifies key areas of improvement and compliance for API-related vulnerabilities. + +2. **`Security-Audit-OWASP-Top-10-Results-localhost-WEB-02122024.pdf`** + - **Description**: Summarizes the OWASP Top 10 compliance results for the OnTrack Web hosted locally at `http://localhost:4200`. + - **Key Highlights**: Focuses on web application security risks and mitigation strategies. + +## Notes +- These reports are for informational purposes and should not be used as a substitute for professional security evaluation. +- Some of the content is derived from the OWASP Top 10 2021 Project document, available at [OWASP](http://www.owasp.org). + diff --git a/reports/security/Security-Audit-OWASP-Top-10-Results-localhost-API-02122024.pdf b/reports/security/Security-Audit-OWASP-Top-10-Results-localhost-API-02122024.pdf deleted file mode 100755 index 80d5e82e..00000000 Binary files a/reports/security/Security-Audit-OWASP-Top-10-Results-localhost-API-02122024.pdf and /dev/null differ diff --git a/reports/security/security_audit_owasp_top_10_results_localhost_api_02122024.pdf b/reports/security/security_audit_owasp_top_10_results_localhost_api_02122024.pdf new file mode 100644 index 00000000..37c91f89 Binary files /dev/null and b/reports/security/security_audit_owasp_top_10_results_localhost_api_02122024.pdf differ diff --git a/reports/security/Security-Audit-OWASP-Top-10-Results-localhost-WEB-02122024.pdf b/reports/security/security_audit_owasp_top_10_results_localhost_web_02122024.pdf old mode 100755 new mode 100644 similarity index 100% rename from reports/security/Security-Audit-OWASP-Top-10-Results-localhost-WEB-02122024.pdf rename to reports/security/security_audit_owasp_top_10_results_localhost_web_02122024.pdf diff --git a/src/README.md b/src/README.md new file mode 100644 index 00000000..3d6c299d --- /dev/null +++ b/src/README.md @@ -0,0 +1,27 @@ +# src + +## Purpose +The `src` directory contains all the core resources required for the OnTrack documentation project. This includes static assets, technical documentation, and configuration for the Astro framework. + +## Structure +### 1. `assets/` +- **Purpose**: Stores static files such as images and media. +- **Contents**: + - `houston.webp`: Related to the Houston project. + - `ontrack.webp`: Associated with the OnTrack project. + +### 2. `content/` +- **Purpose**: Holds the main technical documentation for OnTrack. +- **Subdirectories**: + - **`docs/`**: Contains detailed documentation for different components: + - **`backend/`**: API-related documentation (e.g., `api_list.md`, `students.md`). + - **`courseflow/`**: Documents workflows and future plans (e.g., `current_stage.md`, `requirements.md`). + - **`document/`**: Introductory documentation and setup information. + - **`frontend/`**: Documentation for the frontend setup (e.g., `page.md`). + - **`setup/`**: Contains setup guides (e.g., `set.md`). + +## Notes +- Follow **snake_case** for naming new files and directories. +- New images should be stored in the `assets/` folder. +- When adding pages, ensure to update the `astro.config.mjs` file to link them correctly. +