This application is a component of the Trial Innovation Network which uses TIN Redcap trial data to further the TIN mission "addressing critical roadblocks in clinical research and accelerate the translation of novel interventions into life-saving therapies."
The Clinical Trial Management Dashboard allows participants to upload and customize additional data atop Redcap data, view graphs, create reports and draw critical insight into areas that can be improved across various research processes and ongoing trials.
At a high level, the project is structured around 3 core microservices found in the services directory.
These services are supported by a relational database (postgres) and job caching service (redis).
For local development, the Makefile should be the driver for all local infrastructure setup, container builds, and deployments into the local KiND cluster.
We assume you already have docker installed 🐳.
Follow the setup.mac, setup.windows, setup.linux targets to install the basic software needed.
make kind-up will start a local Kubernetes service in Docker called KiND. ⭐️ You must have the docker service running for this to work.
make kind-down will delete the kubernetes service.
If working on a service, for example the api - you can build the image locally using make build-api. We have provided similarly named docker make targets build-[ui || pipeline] for building the other services.
When deploying the applications into local KiND cluster make kind-load-api or similar kind-load-[ui || pipeline] will load the image directly into the cluster - without needing to push an external container registry (though this can also be done).
make helm-up will deploy the full ctmd-dashboard into the KiND cluster.
make helm-dev-down will delete the ctmd-dashboard helm deployment and pvcs (database data), leaving only the KiND cluster up (for redeploying with changes).
make helm-down will uninstall the ctmd-dashboard deployment without removing the pvc (database data).
make port-forward-ui will expose the frontend to your local development environment on port 3000. localhost:3000/ will then be accessible from a browser.
Automatic container builds occur when pushing to github through github actions. If updates are done to a specific service, only that service container will be built (this saves running costs in Github Actions).
For example if only the services/api code was updated, only that image will be built. The tag will be the branch name, prepended with test_. So if your branch name is adding_pipeline the resultant build will be tagged with test_adding-pipeline.
Every build and tag is sent to Renci's container registry and Dockerhub's rencibuild/ namespace.This ensures disaster recovery for images if mistakenly deleted.