Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions reports/README.md
Original file line number Diff line number Diff line change
@@ -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).

Binary file not shown.
Binary file not shown.
File renamed without changes.
27 changes: 27 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -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.