Dockerized workspace

[zhichli]

This pull request introduces a Dockerized workspace for the project, aiming to streamline development and deployment processes. Here's a detailed breakdown of the changes, rationale, potential risks, and other relevant details:

Changes Made to the Code

1. .dockerignore File Addition:

   • A .dockerignore file has been added to exclude unnecessary files and directories from being included in the Docker image.
   • Exclusions include Python cache files (__pycache__, *.pyc), Git repository files (.git), certain IDE/editor configurations (*.vscode, *.idea), and documentation files (*.md).

2. Dockerfile Creation:

   • A new Dockerfile has been created to construct a Docker image for the application.
   • The image is based on the official python:3.11-slim image to ensure a lean, secure environment.
   • Sets the working directory inside the container to /app.
   • Copies the requirements.txt file for dependency management and runs pip install to install the necessary Python packages.
   • Copies the source application files from src/app into the container.
   • Exposes port 8080 for the FastAPI application to listen for incoming requests.
   • Sets the command to start the FastAPI application using uvicorn, ensuring the server hosts the app at 0.0.0.0 on port 8080.

Rationale for the Changes

• Environment Consistency: Containerization ensures that the application runs consistently across different environments (development, testing, production).
• Ease of Deployment: Dockerizing the application simplifies deploying it to various platforms and environments, including cloud services that support Docker.
• Dependency Management: The use of a Docker image enables controlled and isolated installation of Python dependencies, reducing potential conflicts.

Potential Risks or Considerations

• Image Size: While the python:3.11-slim image is relatively lightweight, there may still be concerns about image size if many dependencies are present in requirements.txt.
• Security Concerns: It’s crucial to keep the base image and libraries updated to mitigate security vulnerabilities.
• Port Exposure: Ensure that exposing port 8080 aligns with device and network security policies.

Other Relevant Details

• Functional Testing: The project has been successfully tested within the Docker container environment, confirming that the application behaves as expected with the specified Docker configuration.
• Further Assistance: The change log mentions readiness to provide further assistance if needed, indicating support for integration and usage of the Docker setup.

This PR effectively addresses the need for creating an isolated and portable development environment for the application, using Docker for efficient software management.