# Technical documentation

- **Purpose:** Technical Documentation is dedicated to the technical aspects of the application, including its
  implementation, configuration, and system details. It assists developers in understanding the inner workings of the
  application.

- **Folder Location:** Technical documentation is organized in the "technical" subfolder within "docs."

## Table of Contents

- [Technical Documentation](#technical-documentation)
- [Getting Started](#getting-started)

## Technical Documentation

Dive deep into the technical aspects of the project with the following documentation:

- **Anonymization**: Understand data protection and anonymization processes. [Read more](./docs/technical/anonymization.md).
- **Scheduled Tasks (Cron Jobs)**: Details on scheduled tasks and their configurations. [Read more](./docs/technical/cron.md).
- **CVE**: Information on Common Vulnerabilities and Exposures related to the project. [Read more](./docs/technical/cve.md).
- **Deployment**: Step-by-step guide on deploying the project across different environments. [Read more](./docs/technical/deployment.md).
- **ESM**: Documentation on Entity, Service, and Manager generation. [Read more](./docs/technical/esm.md).
- **Installation**: A comprehensive guide on setting up the project for development. [Read more](./docs/technical/installation.md).
- **Makefile**: Understand the utility of the Makefile and its commands. [Read more](./docs/technical/make.md).
- **Database Migrations**: Instructions on database migrations and their management. [Read more](./docs/technical/migration.md).
- **SSL Certificates**: Guide on setting up self-signed SSL certificates for local development. [Read more](./docs/technical/selfSignCertficates.md).
- **Debugging with Xdebug**: Tips and configurations for debugging PHP using Xdebug. [Read more](./docs/technical/xdebug.md).

## Getting Started

1. **Prerequisites**: List of software/tools required.
2. **Installation**: Follow the [installation guide](./docs/technical/installation.md) to set up the project.
3. **Running the Project**: Instructions on how to run the project locally. (after installation)
   ```bash
   make up
   make down
   ```