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

Update README with instructions for local development #124

Open
codebanesr opened this issue Jul 20, 2023 · 0 comments
Open

Update README with instructions for local development #124

codebanesr opened this issue Jul 20, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@codebanesr
Copy link
Contributor

Here is one way to convert that to a Jira issue:

Summary: Update README with instructions for local development

Description:

The make install command uses a cache, which makes it difficult to confirm code changes. The README should be updated to provide instructions for developers on how to work on the project locally and see changes reflected without needing to rebuild the Docker image.

Some options to consider adding:

  • Instructions for volume binding in docker-compose.yml to sync local code changes to the running container
  • Setup steps for running the app locally outside of Docker for faster iteration
  • Commands to rebuild the image when ready to test the fully built artifact

Having documentation on how to develop locally will improve the developer experience and allow for faster development cycles.


To ensure my local changes are reflected, I am currently clearing out old Docker artifacts and volumes by running:

docker volume prune 

docker system prune --all --force

This removes any cached or stale volumes and images, forcing Docker to rebuild from the latest local code changes on the next run.

While this works, it is not ideal as it removes all Docker artifacts rather than just those associated with this project. The README should be updated with preferred instructions for efficiently reloading just this project's volumes during development.

@gharbat gharbat self-assigned this Jul 20, 2023
@gharbat gharbat added the enhancement New feature or request label Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants