Testing Leaf

Interesting in trying Leaf out? Great! Below are a few options, depending on your environment and preferences.

Local Computer

MacOS

These instructions assume you

• Are comfortable using bash or other Unix-based command line tools
• Have Docker installed (to run the API and DB)
• Have npm installed (to run the client)
• Have sqlcmd installed (to populate the database)

---

1. Complete the following steps in the Leaf Installation Guide:

   • 3 - Create a JWT Signing Key

   • 7 - Set Environment Variables

   Environment Variables must be visible to the Docker containers run from the command line, though you can configure them however you'd like

2. Build and populate the Leaf API and databases. On the command line run:

   $ cd /leaf
   $ ./containerize_leaf.sh
   

   You should see output indicating the app and clinical database containers are up and populated with data, followed by the API:

   

   Alternatives to using containerize_leaf.sh

   Database - If you have an existing SQL Server Docker container, you can simply build the app database as described in 1 - Create App Database.

   ---

   API - You can either:

   • Manually build and run the Leaf API Dockerfile (see ./containerize_leaf.sh for an example of how to do this)

   or

   • If you prefer not to use Docker and have the dotnet cli installed, in bash, run:

   $ cd /leaf/src/server/API
   $ dotnet run
   

3. In a separate command line window, run the Leaf client:

   $ cd /leaf/src/ui-client
   $ npm install
   $ npm start
   

   

   Success! Leaf should start up in your browser using http://localhost:3000

   If you run into errors check the Leaf Troubleshooting Guide

Windows

These instructions assume you

• Have SQL Server 2014+ installed and accessible by localhost with a clinical database available to test with
• Have a Unix-like command line tool such as Cygwin installed
• Have the dotnet cli installed (to run the API)
• Have npm installed (to run the client)

---

1. Complete the following steps in the Leaf Installation Guide:

   • 1 - Create App Database (on localhost)

   • 3 - Create a JWT Signing Key

   • 7 - Set Environment Variables

   Setting Environment Variables at the System level is usually simplest, though any method works as long as the Environment Variables are visible to the API

2. As your application and clinical datatases should now be running on SQL Server localhost, next we'll run the Leaf API. On the command line run:

   $ cd /leaf/src/server/API
   $ dotnet run
   

   You should see something like:

   

3. In a separate command line window, run the Leaf client:

   $ cd /leaf/src/ui-client
   $ npm install
   $ npm start
   

   

   Success! Leaf should start up in your browser using http://localhost:3000

   If you run into errors check the Leaf Troubleshooting Guide

Remote Server

Linux

Coming soon!

Windows

Coming soon!

Access a UW Test Instance

Please contact us at leafsupport@uw.edu, as we have several Leaf instances with synthetic data used for demonstration purposes and hosted at the University of Washington. While we'd like to have these available on the internet without making you jump through hoops, for various security reasons we ask that you just reach out to us and let us know you're interested, after which we'll grant you access.