Updated README.md

README.md

@@ -1,14 +1,62 @@
-Got it! Here’s the updated README with links to the documentation files in the `./docs` subfolder:
-
----
-
 # FastAPI-Demo
 [![Docker Image CI Github Actions](https://github.com/ITlusions/ITL.FastApi.Demo/actions/workflows/docker-image.yml/badge.svg)](https://github.com/ITlusions/ITL.FastApi.Demo/actions/workflows/docker-image.yml)
 [![Build Status - Azure Pipelines](https://dev.azure.com/ITlusions/ITL.FastAPI.Demo/_apis/build/status%2FITL.FastAPI.Demo.Build?branchName=main)](https://dev.azure.com/ITlusions/ITL.FastAPI.Demo/_build/latest?definitionId=35&branchName=main)
 
-## Une exploration à travers la technologie
+ - [Project structure](#project-structure-overview)
+
+ - [Documentation](#documentation)
+
+
+## Project Structure Overview
+
+This project is designed for a FastAPI application with integrated CI/CD pipelines, Docker, Helm charts, and Tekton pipelines. Below is a breakdown of the project's structure and key components:
+
+### Root Directory
+- **`.gitignore`**: Specifies which files and directories Git should ignore.
+- **`azure-pipelines.yml`**: Configuration file for Azure Pipelines.
+- **`Dockerfile`**: Defines the Docker image for the application.
+- **`README.md`**: Project overview and documentation.
+- **`requirements.txt`**: Lists Python dependencies.
+
+### `.github`
+- **`dependabot.yml`**: Configuration file for GitHub Dependabot, which helps keep dependencies updated.
+- **`workflows`**
+  - **`docker-image.yml`**: GitHub Actions workflow for building and managing Docker images.
 
-Just a place to demo some stuff...
+### `.pytest_cache`
+- Contains cache files for pytest, which are used to store test results and speed up test runs.
+
+### `.tekton`
+- **`chart`**: Helm chart directory containing Tekton pipelines and tasks.
+  - **`tekton-pipelines`**: Tekton pipelines Helm chart with YAML files for pipelines and tasks.
+- **`pipelines`**: Tekton pipeline definitions.
+- **`tasks`**: Tekton task definitions for Docker image building, linting, security scanning, and Python setup.
+- **`workspace`**: Persistent volume claim YAML for Tekton pipelines.
+
+### `.vscode`
+- **`launch.json`**: VSCode configuration for debugging.
+
+### `app`
+- **`main.py`**: Entry point of the FastAPI application.
+- **`base`**: Contains core application components like logging and settings.
+  - **`logging`**: Logging configuration and utility files.
+  - **`settings`**: Configuration files and documentation for settings.
+- **`models`**: Python modules defining data models.
+- **`routers`**: FastAPI routers for different endpoints.
+- **`tests`**: Unit tests for the application.
+
+### `charts`
+- **`itl.fastapi.demo`**: Helm chart for deploying the FastAPI application.
+  - **`charts`**: Sub-charts (if any) used in the main chart.
+  - **`templates`**: Kubernetes manifests for deployment, service, ingress, etc.
+
+### `docs`
+- **`tutorial-findindfixingsqlinject.md`**: Documentation related to finding and fixing SQL injections.
+- **`versioning.md`**: Documentation detailing the versioning strategy and related scripts.
+
+---
+
+This structure supports a development and deployment workflow, integrating CI/CD pipelines, Docker, Helm, and Tekton. Each component is managed from a single repo to facilitate easy updates and maintenance, and to ensure a consistent deployment process.
 
 This project is also hosted on [Azure Devops].
 
@@ -32,5 +80,3 @@ This project is also hosted on [Azure Devops].
    [ITlusions]: <https://github.com/ITlusions>
    [Niels Weistra]: <mailto:[email protected]>
    [Azure Devops]: <https://dev.azure.com/ITlusions/ITL.FastAPI.Demo/>
-
----