jackson
jackson copied to clipboard
feat(docker-compose): run jackson service
What does this PR do?
This PR intends to facilitate the deployment of the Jackson service, using docker compose. I transferred the docker command provided in the documentation into a generic docker compose file. I'm not sure what makes the most sense regarding the DB settings, so for now I have only added the Postgres env variables.
Fixes #61 (issue)
Type of change
- [X] New feature (non-breaking change which adds functionality)
- [X] This change requires a documentation update
How should this be tested?
- Start your postgres DB
- In your root folder, run:
docker compose up
This should create a container named jackson
, running on port 5225
.
3. The service is accessible at the following address: http://localhost:5225/. And if you go to http://localhost:5225/api/health
, it will return your current version of Jackson (for me it was {version: "1.13.0"}
).
Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code and corrected any misspellings
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
Hi @devkiran, I left a comment on the issue to get more detailed ACs from you, but I can open this PR for review and leave it as is if you think that's already a good start. Let me know your preference!