Skip to main content

Run the Stack

Follow these instructions to get the complete Medplum stack running directly on your host machine.

Prerequisites

  1. Npm: See the npm documentation for instructions on installing it with your OS.
  2. Clone the Medplum repo
Note for windows Users

Running on Windows is supported, but several build tools use bash scripts. We recommend MSYS2 to run them.

Install

Our monorepo uses npm workspaces, so installing dependencies for all projects is done using normal npm install:

cd medplum
npm ci

Background services

The Medplum Stack requires the following services to be running in your environment:

When running this services on your local machine you can either use Docker (recommended) or install them directly onto your machine.

Use the supplied docker-compose.yml file to run PostgreSQL and Redis background services. These services will be deployed with all necessary medplum configurations and database migrations.

From your root medplum directory run

docker-compose up

This will:

  1. Start the PostgreSQL server in a container
  2. Set up the appropriate configurations (see postgres.conf)
  3. Create two databases for testing: medplum and medplum_test (see init_test.sql)

When docker-compose completes, you should see something like this in your terminal:

medplum-postgres-1  | PostgreSQL init process complete; ready for start up.
medplum-postgres-1 |
medplum-postgres-1 | 2022-07-29 00:37:44.639 GMT [1] LOG: starting PostgreSQL 12.10 (Debian 12.10-1.pgdg110+1) on aarch64-unknown-linux-gnu, compiled by gcc (Debian 10.2.1-6) 10.2.1 20210110, 64-bit
medplum-postgres-1 | 2022-07-29 00:37:44.639 GMT [1] LOG: listening on IPv4 address "0.0.0.0", port 5432
medplum-postgres-1 | 2022-07-29 00:37:44.639 GMT [1] LOG: listening on IPv6 address "::", port 5432
medplum-postgres-1 | 2022-07-29 00:37:44.642 GMT [1] LOG: listening on Unix socket "/var/run/postgresql/.s.PGSQL.5432"
medplum-postgres-1 | 2022-07-29 00:37:44.650 GMT [88] LOG: database system was shut down at 2022-07-29 00:37:44 GMT
medplum-postgres-1 | 2022-07-29 00:37:44.654 GMT [1] LOG: database system is ready to accept connections

(Optional) If you'd like to run a psql to shell to inspect the database, you can run

docker exec -it medplum-postgres-1 psql -U medplum

Where medplum-postgres-1 can be replaced with the name of your postgres docker container.

Deploying manually

If you'd prefer to install the dependencies directly, you can find installation instructions for the required services below:

  1. Install PostgreSQL
  2. Install Redis

After that, you will have to update the file packages/server/medplum.config.json

  "database": {
"host": "", // YOUR POSTGRESQL HOST
"port": "", // YOUR POSTGRESQL PORT
"dbname": "", // YOUR POSTGRESQL DB Name
"username": "", // YOUR POSTGRESQL USERNAME
"password": "" // YOUR POSTGRESQL PASSWORD
},
"redis": {
"host": "", // YOUR REDIS HOST
"port": "", // YOUR REDIS PORT
"password": "", // YOUR REDIS PASSWORD
}

Build and Test

We provide convenience scripts to perform a full build and test:

./scripts/build.sh

This will do the following:

  • Install npm dependencies if not already installed
  • Build all packages
  • Run all tests
  • Run linter

Run

Start the servers

After you have PostgreSQL and Redis up and running, you can run the Medplum API server.

From your root medplum directory run:

cd packages/server
npm run dev

This will seed the medplum database with an example project and user. The email and password for the example user are:

Emailadmin@example.com
Passwordmedplum_admin

To make sure the server is working, you can access the health check at http://localhost:8103/healthcheck

If everything is working, you should see the following in your browser:

{ "ok": true, "postgres": true, "redis": true }

Run the Medplum Web App

Lastly, you can start the Medplum Wep App.

From your root medplum directory run:

cd packages/app
npm run dev

You can access the app at http://localhost:3000/