Skip to content

README.md

Latest commit

 

History

History
104 lines (78 loc) · 3.35 KB

README.md

File metadata and controls

104 lines (78 loc) · 3.35 KB
Raw

GFmodules NVI beheer API

This app is a management API for registering and administering organisations and their clients within the NVI system, and is part of the 'Generieke Functies, lokalisatie en addressering' project of the Ministry of Health, Welfare and Sport of the Dutch government. This application is responsible for managing organisations identified by URA, their associated client registrations, and client resolution based on OIN, common name, and organisation URA.

Caution

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.

Usage

The application is a FastAPI application, so you can use the FastAPI documentation to see how to use the application.

Getting started

You can either run the application natively or in a docker container. If you want to run the application natively you can take a look at the initialization steps in docker/init.sh.

The preferred way to run the application is through docker.

Standalone setup

If you run Linux, make sure you export your user ID and group ID to synchronize permissions with the Docker user.

export NEW_UID=$(id -u)
export NEW_GID=$(id -g)

After this you can simply run docker compose up.

The application will be available at http://localhost:8502 when the startup is completed.

Docker container builds

Build the container with:

    make container-build

This builds the FastAPI service image for this repository.

If you want the standalone entrypoint instead of the default one, build with the standalone build arg:

    make container-build-sa

The two image variants only differ in which init script is selected.

Contribution

As stated in the Disclaimer this project and all associated code serve solely as documentation and demonstration purposes to illustrate potential system communication patterns and architectures.

For that reason we will only accept contributions that fit this goal. We do appreciate any effort from the community, but because our time is limited it is possible that your PR or issue is closed without a full justification.

If you plan to make non-trivial changes, we recommend opening an issue beforehand where we can discuss your planned changes. This increases the chance that we might be able to use your contribution (or it avoids doing work if there are reasons why we wouldn't be able to use it).

Note that all commits should be signed using a gpg key.

When starting to introduce changes, it is important to leave user specific files such as IDE or text-editor settings outside the repository. For this, create a local .gitignore file and configure git like below.

git config --global core.excludesfile ~/.gitignore