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.
Here is one way to convert that to a Jira issue:
Summary: Update README with instructions for local development
Description:
The
make installcommand 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:
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:
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.