Skip to content

Commit

Permalink
Update readme with instructions to run locally
Browse files Browse the repository at this point in the history
  • Loading branch information
JanPannecoeck committed Nov 27, 2024
1 parent ac4a476 commit e9138e1
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,26 @@ Issues: **https://github.com/hl7-be/patient-monitoring/issues**
Kanban board: **https://github.com/hl7-be/patient-monitoring/projects/1**

---

### Running locally

1. Install Prerequisites
Before running a FHIR IG locally, ensure you have the necessary tools installed:

a. Java
FHIR tools like the IG Publisher require Java. Download and install Java.

b. Node.js and npm
Some IGs may use Node.js scripts. Download and install Node.js.

c. FHIR IG Publisher
The FHIR IG Publisher tool is essential for generating and validating IGs. Download the latest publisher.jar from [here](https://github.com/HL7/fhir-ig-publisher/releases).

d. Jekyll (Optional)
If your IG uses Jekyll for hosting and templating, install Jekyll. Ensure Ruby and Bundler are installed.

Run Locally:

```
java -jar path/to/publisher.jar -ig ig.ini
```

0 comments on commit e9138e1

Please sign in to comment.