refactor(api): move api to this repository

[0x1026]

This pull request introduces several updates to the project, focusing on improving the CI/CD pipeline, adding support for a new API, and enhancing the overall project configuration and documentation. The most important changes include modifications to the GitHub Actions workflows, updates to the Docker configuration, and enhancements to the environment and dependency management.

Move the API to this repository, improve the Docker and CI configurations, and enhance the testing setup with coverage reporting. Simplify the Sensor model and update field names for better clarity.

CI/CD Pipeline Enhancements:

• .github/workflows/main.yml: Added a new job to detect changes and updated the workflow to include the new API service in the build and test processes. [1] [2] [3] [4] [5]
• .github/workflows/tests.yml: Updated the tests workflow to conditionally run tests for the new API service based on the detected changes. [1] [2]

Docker Configuration:

• Dockerfile: Added configurations for setting up and running the development and test environments with Xdebug. [1] [2]
• api/Dockerfile: Introduced a new Dockerfile for the API service, including separate stages for dependencies, development, and production.

Environment and Dependency Management:

• .env.example: Updated the database user and password configuration for better security.
• api/requirements.txt and api/requirements-dev.txt: Added necessary dependencies for the FastAPI service and testing. [1] [2]

Project Configuration:

• .github/dependabot.yml: Added configuration for Dependabot to manage Python dependencies for the new API service.
• .github/file-filters.yml: Introduced file filters for the new API service to optimize the CI/CD process.
• .vscode/settings.json: Updated VS Code settings to include schema validation for the new Docker Compose file.

Documentation:

• README.md: Enhanced the installation instructions to include environment variable setup and access URLs for different parts of the application.

Resources

• https://github.com/codecov/example-php/blob/main/.github/workflows/ci.yml
• https://github.com/codecov/example-python/blob/main/.github/workflows/ci.yml
• https://docs.github.com/en/actions/sharing-automations/reusing-workflows
• https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-jobs-in-a-workflow#defining-prerequisite-jobs
• https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/evaluate-expressions-in-workflows-and-actions#hashfiles
• https://gist.github.com/GuillaumeFalourd/1b3755612299523e2602bdc35df7441b
• https://github.com/codecov/codecov-action
• (Not yet) https://github.com/iamtodor/demo-github-actions-python-linter-configuration/tree/main
• https://github.com/php-actions/composer?tab=readme-ov-file#passing-arguments
• https://github.com/PhpGt/Database/blob/master/.github/workflows/ci.yml
• https://stackoverflow.com/a/75735736
• https://github.com/dorny/paths-filter/?tab=readme-ov-file#paths-changes-filter
• (Not yet) https://dev.to/jackmiras/xdebug-in-vscode-with-docker-379l
• https://github.com/sebastianbergmann/phpunit/blob/main/phpunit.xml
• https://github.com/sebastianbergmann/phpunit/blob/main/.github/workflows/ci.yaml#L187-L226
• (Not yet) https://github.com/sebastianbergmann/php-code-coverage
• https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/running-variations-of-jobs-in-a-workflow
• https://github.com/reproducible-containers/buildkit-cache-dance
• (Not yet) https://docs.docker.com/engine/swarm/services/
• (Not yet) https://docs.docker.com/engine/swarm/stack-deploy/

[codecov]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️