Improve Development Environment Consistency with Docker
Objectives
To create a Docker-based development environment for the backend to ensure consistency across different devices.
To simplify the onboarding process for new contributors by eliminating the need to install dependencies locally.
Description
We aim to streamline the setup process for our backend development environment and ensure consistency across all contributors' devices. By utilizing Docker containers, we can encapsulate our development environment and its dependencies, allowing contributors to quickly onboard and start developing, regardless of their local machine setup.
Acceptance Criteria
Dockerfile Creation: A Dockerfile must be created specifying all the necessary dependencies and configurations required to run the backend application.
Docker-Compose Configuration: A docker-compose.yml file should be provided to manage the application as a service and include all required dependencies.
Simplicity in Commands: Contributors should be able to get the backend running by executing a simple docker-compose up command. This process should handle the building of the Docker image and the initialization of the container(s).
Documentation: Include detailed instructions in the repository's README file, explaining how to use Docker and Docker Compose to set up the development environment. This documentation should cater to contributors who may not be familiar with Docker.
Cross-Device Compatibility: The Docker setup must be tested and confirmed to work on Windows, macOS, and Linux, ensuring a consistent development environment across different operating systems.
How to Test
Environment Setup: Follow the instructions added to the README to set up the Docker environment using docker-compose up and to shutdown the Docker Environment using docker-compose down.
Verify Running Application:
Ensure that the backend application is accessible and running as expected. This can be tested by hitting a known endpoint using a tool like curl or Postman and verifying the response.
Dependency Check:
Confirm that no local installation of the application's dependencies is required to run the backend successfully in the Docker container.
Cross-Platform Verification:
Test the setup on different operating systems (at least Windows, macOS, and Linux) to confirm cross-device compatibility.
Issue
Objectives
Description We aim to streamline the setup process for our backend development environment and ensure consistency across all contributors' devices. By utilizing Docker containers, we can encapsulate our development environment and its dependencies, allowing contributors to quickly onboard and start developing, regardless of their local machine setup.
Acceptance Criteria
Dockerfile Creation: A Dockerfile must be created specifying all the necessary dependencies and configurations required to run the backend application.
Docker-Compose Configuration: A docker-compose.yml file should be provided to manage the application as a service and include all required dependencies.
Simplicity in Commands: Contributors should be able to get the backend running by executing a simple docker-compose up command. This process should handle the building of the Docker image and the initialization of the container(s).
Documentation: Include detailed instructions in the repository's README file, explaining how to use Docker and Docker Compose to set up the development environment. This documentation should cater to contributors who may not be familiar with Docker.
Cross-Device Compatibility: The Docker setup must be tested and confirmed to work on Windows, macOS, and Linux, ensuring a consistent development environment across different operating systems.
How to Test
Environment Setup: Follow the instructions added to the README to set up the Docker environment using docker-
compose upand to shutdown the Docker Environment usingdocker-compose down.Verify Running Application:
Dependency Check: