Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-requisite checks for the CLI tool #338

Open
4 tasks
adnanhashmi09 opened this issue May 9, 2024 · 0 comments
Open
4 tasks

Add pre-requisite checks for the CLI tool #338

adnanhashmi09 opened this issue May 9, 2024 · 0 comments
Labels
enhancement New feature or request javascript Pull requests that update Javascript code

Comments

@adnanhashmi09
Copy link
Contributor

adnanhashmi09 commented May 9, 2024

Description:

Before running the docker-compose watch command to set up the development environment, we should add some pre-requisite checks to ensure that the necessary components are available and the required files exist. This will help catch potential issues early and provide a better user experience.

Pre-requisite Checks:

  • Check if the required ports are available (list the specific ports needed)
  • Check if the Docker daemon is running
  • Check if the docker-compose.yml file exists in the project directory
  • Check if the Dockerfile.dev exists in the project directory

Implementation Steps:

  1. Identify the required ports for the development environment and add a check to ensure they are not already in use.
  2. Add a check to verify if the Docker daemon is running on the system.
  3. Add a check to ensure that the docker-compose.yml file exists in the project directory.
  4. Add a check to ensure that the Dockerfile.dev exists in the project directory.
  5. Display appropriate error messages or prompts if any of the pre-requisite checks fail.
  6. Proceed with the docker-compose watch command only if all pre-requisite checks pass.

Additional Considerations:

  • Handle different operating systems (e.g., Linux, macOS, Windows) for checking the Docker daemon status.
  • Provide clear instructions or guidance if any of the pre-requisite checks fail, such as suggesting solutions or troubleshooting steps.
  • Consider adding unit tests for the pre-requisite check functions.
@adnanhashmi09 adnanhashmi09 added enhancement New feature or request javascript Pull requests that update Javascript code labels May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request javascript Pull requests that update Javascript code
Projects
None yet
Development

No branches or pull requests

1 participant