TODO
- Docker v27 (older versions may be sufficient, unverified)
- Optional:
- Node v22
- v18 may be sufficient
- not strictly required. At the moment, it's mainly to run the script shorthands inside the root
package.json
. If you don't have Node, anywhere you see anpm run <command>
statement below, you can look up<command>
in package.json and run the corresponding terminal command directly (does not apply to shorthands for furthernode ...
ornpm ...
commands obviously, but those are currently optional)
- VSCode
- not strictly required, other editors could be used, but assumed in future steps
- Node v22
- Clone repository locally
- Open a terminal inside the repo root
- (Optional) run
npm run ci:all
in the repo root, to install all project and service dependencies - (Optional) install recommended vscode exstensions (see
.vscode/extensions.json
) - Start the local dev docker-compose environment with
npm run dev
from the repo root- or manually run the
predev
anddev
commands as defined in the rootpackage.json
- or manually run the
- Wait for docker-compose services to finish spinning up
- The following routes should now be available
- Mock Ontario Services
- http://localhost:8080/on/fhir
- a HAPI FHIR JPA server, loaded with synthetic data
- http://localhost:8080/on/browser
- a FHIR patient browser pointed at the corresponding mock FHIR server
- http://localhost:8080/on/aggregator/aggregated-data
- REST endpoint for IPVD-format-compliant aggregated records from the corresponding mock FHIR server
- transfer routes TBD
- http://localhost:8080/on/fhir
- Mock B.C. Services
- http://localhost:8080/bc/fhir
- a HAPI FHIR JPA server, loaded with synthetic data
- http://localhost:8080/bc/browser
- a FHIR patient browser pointed at the corresponding mock FHIR server
- http://localhost:8080/bc/aggregator/aggregated-data
- REST endpoint for IPVD-format-compliant aggregated records from the corresponding mock FHIR server
- transfer routes TBD
- http://localhost:8080/bc/fhir
- Mock Federal Services
- http://localhost:8080/fed/federated-aggregator/aggregated-data
- REST endpoint for IPVD-format-compliant aggregated records, federated from each PT aggregator
- http://localhost:8080/fed/shiny-dashboard
- not yet implemented
- http://localhost:8080/fed/federated-aggregator/aggregated-data
- Mock Ontario Services