Mijn Gezondheidsoverzicht (web)

This repository contains the "Mijn Gezondheidsoverzicht", or MGO, application and components. It is a monorepo which contains multiple individual apps and packages. To learn more about the MGO app itself please visit the about page.

Disclaimer

This project and all associated code serve solely as documentation and demonstration purposes to illustrate potential system communication patterns and architectures.

This codebase:

• Is NOT intended for production use
• Does NOT represent a final specification
• Should NOT be considered feature-complete or secure
• May contain errors, omissions, or oversimplified implementations
• Has NOT been tested or hardened for real-world scenarios

The code examples are only meant to help understand concepts and demonstrate possibilities.

By using or referencing this code, you acknowledge that you do so at your own risk and that the authors assume no liability for any consequences of its use.

Documentation

• About the app
• Development setup
• End-to-end tests
• Deployment
• Internationalization / copy content
• Glossary

Directory structure

This repository is a monorepo in that all directories under apps/* and packages/* are condisered their own individual package and contain their own dependencies and scripts. Only a few things are organised at the root level, such as formatting and linting.

├── apps
│    └── mgo                # The main MGO application
│    └── mgo-e2e            # End-to-end tests for the mgo application
├── packages
│    ├── data-services      # HTTP client for making requests to data services
│    ├── fhir-client        # A basic HTTP client for making requests to a FHIR server
│    ├── fhir-data          # Helpers for parsing FHIR data structures and generating "health ui schema"'s
│    ├── fhir         # Collection of TypeScript types for dealing with different Fhir (version) elements
│    ├── intl               # Contains all the text content and translations for the MGO app and the "health ui schema"'s
│    └── tailwind           # MGO Tailwind theme
│    ├── ui                 # UI library for the MGO app
│    ├── utils              # Collection of commonly used utility functions
├── docs
│    └── ...                # Documentation files
├── LICENSE
└── README.md               <-- you are here

Quick run

To run the MGO app locally there is a docker-compose configuration available. This is only meant for testing the application, it is not to be used in production. For actual development, we recommend you use the Development instructions instead. To run the MGO app locally using docker, ensure you have the latest Docker (Desktop) installed.

# Build and run a local test server using docker
docker compose up --build mgo
# Stop local test server
docker compose down

By default it will connect to the test environments, however this can be changed by adding a .env in the apps/mgo-e2e directory. You can copy the .env.example for some default values.

After changing .env values you will have to rebuild and restart the container. (Rerun the first command above)

Scripts

Once you have a local development environment] set up, there are several pnpm scripts you can run from this root directory. To run a command, open a new terminal from this root directory and enter the following command:

pnpm run <command>

Command	Description
dev	Starts a new vite development server.
test	Runs all unit tests using vitest.
test:coverage	Runs all unit tests using vitest and publishes a coverage report.
lint	Lints all the code using eslint.
lint:fix	Fixes all fixable lint errors using eslint.
typecheck	Checks all the types using TypeScript
storybook	Starts a new server with the documentation on components from the mgo-ui package using Storybook
format	Checks and fixes any formatting issues using Prettier
format:check	Checks only any formatting issues using Prettier
messages:update	Download latest translations from lokalise, see mgo-intl for details.
pr	Runs all the checks that are normally also ran for a pull request
e2e	Runs the end-to-end tests for the mgo app using Playwright
graph	Graph dependencies within workspace.

NX

We have started using nx for managing processing within this monorepo such as building, typechecking or linting. We also use nx to publish certain packages. See the nx.json for details.

You can use nx to run certain tasks for projects or viewing a graph of the entire monorepo. Running a command for a specific project:

npx nx run <project>:<command>

Some commonly used nx commands and examples

Command	Description
pnpm exec nx graph	Graph dependencies within workspace
pnpm exec nx run mgo:build	Create a production build for the mgo app
pnpm exec nx run mgo:dev	Start a development server for the mgo app
pnpm exec nx run mgo:typecheck	Check the types for the mgo app (and its dependencies)
pnpm exec nx run mgo-utils:typecheck	Check the types for the mgo utils package (and its dependencies)
pnpm exec nx show project mgo-utils	Check the types for the mgo utils package (and its dependencies)

We also use nx to publish certain packages to NPM. For more information on this please visit the NPM packages documentation]

Contributing

If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository of this package.

License

The source code is released under the EUPL license. The documentation is released under the CC0 license. The EUPL 1.2 and the CC0 do not apply to photos, videos, infographics, fonts or other forms of media. Specifically the rijkslogo and rijkshuisstijl have specific terms of use.

This repository follows the REUSE Specfication v3.3. Please see REUSE.toml and the individual *.license files for copyright and license information.

---