QuickStart.md

Quick Start Guide

This is a quick start guide for running the DPC API on your local environment. For full documentation, see the User Guide.

SECURE

Create the .vault_password file in the project root:

The files committed in the ops/config/encrypted directory hold secret information and are encrypted with Ansible Vault.

In order to encrypt and decrypt configuration variables, you must create a .vault_password file in the root directory. Contact another team member to gain access to the vault password.

Afterwards, run the following to decrypt files for local development:

make secure-envs

BUILD

Run the make ci-app command.

CONFIGURE

• Run the make start-app command.
• Verify successful launch by running the command curl -H "Accept: application/fhir+json" http://localhost:3002/v1/metadata. You should view the server's response if all goes well.

Edit the docker-compose.yml file

Ports

When running locally, you'll need to update the docker-compse.yml file by adding:

ports: 
  - "5432:5432"

in the db service. E.g.:

db: 
  image: postgres:11 
  ports: 
    - "5432:5432"

JVM Authentication

Set authentication_disabled for JVM set to [true] in the api service in the same file.

AUTH_DISABLED=true

By default, the Docker containers start with minimal authentication enabled, meaning that some functionality (such as extracting the organization_id from the access token) will not work as expected and always return the same value. This can be overridden during startup by setting the AUTH_DISABLED=false environment variable.

RUN

Run the make start-dpc.

• Clear the project's cache by running the command: docker exec -it ${containerID} rails dev:cache.
• Request access by visiting http://localhost:3900.
• Simulate the approval process by visiting http://localhost:3900/letter_opener and clicking on the confirm my account link.

If no EUA is granted, you will have to manually populate the necessary db tables. Sample tables are provided here. Once populated, you should see the options to create a public key and a client token.

Create Public Key
	-- Use notepad to convert CRLF to LF

TEST

Test with Postman

Once the development environment is up and running, you should now be able to run some calls to the API via the DPC Postman Collections. Below, are a few for verifying a functional development environment:

• Register single patient
• Register practitioner
• Get all groups
• Add patient to group
• Create export data request