Health-Informatics-UoN / Carrot-Mapper

Carrot: Convenient And Reusable Rapid Omop Transformer.

https://carrot4omop.ac.uk

MIT License

12 stars 3 forks source link

Docs/135771 Add developer quickstart #602

Closed AndyRae closed 5 months ago

AndyRae commented 7 months ago

Changes

Adds a developer quick start to get the app running, with corresponding documentation: https://github.com/HDRUK/CaRROT-Docs/pull/17

Includes:

Adds a docker-compose to get the stack running.
Updates the sample-env and sample-local-settings to use default values that work with the docker environment.
Adds seed data fixtures to populate the OmopTable and OmopField tables.
Adds python-dotenv as a dependency, to enable loading configuration from environment variables on all systems.
Updates readme to point to the docs, it doesn't feel necessary to maintain both.

Checks

Important: please complete these before merging.

[ ] Run migrations, if any.
[ ] Update changelog.md, including migration instructions if any.
[ ] Run unit tests.