Zaakvolgsysteem (ZVS)

The Ministry of Health, Welfare and Sport (VWS) processes Woo requests as well as objections and appeals through the Directorate for Legislation and Legal Affairs (WJZ) and the Program Directorate for Transparency (PDO).

iRealisatie is developing a modern case management system to support these processes. It will handle workflows for Woo, objections, and appeals, automatically monitor deadlines, enable document search and reuse, and provide dashboards on workload and processing times. This secure web application will give management better insight, improve efficiency and compliance, and ensure timely and accurate reporting for VWS.

Getting started

Prerequisites

• An up-to-date Docker (Desktop) installation

Setup

1. Clone this repository: git clone git@github.com:minvws/nl-rdo-zvs-web-private.git zvs

2. Cd into the newly created zvs folder: cd zvs

3. Open a new terminal at the root of this folder

4. Create an .env file by copying the ./.env.example to ./.env: cp .env.example .env

5. Create an .env.robot file by copying the ./.env.robot.example to ./.env.robot: cp .env.robot.example .env.robot

6. Setup docker using laravel/sail by running:

   docker run --rm \
       -u "$(id -u):$(id -g)" \
       -v "$(pwd):/var/www/html" \
       -w /var/www/html \
       -e TELESCOPE_ENABLED=false \
       composer:latest \
       composer install --ignore-platform-reqs
   

Note

You might see a warning about a missing connection pgsql driver (database) and a telescope_entries table related query. The migrations (step 9) will fix this issue. You can ignore it for now.

installing the application in sail

For more information see: https://laravel.com/docs/12.x/sail#installing-sail-into-existing-applications

(The steps below assume you have an alias for ./vendor/bin/sail, if not run: alias sail=./vendor/bin/sail)

1. Start the container by running sail up -d laravel.test
2. Run sail npm install && sail npm run build to build the node environment
3. Run sail artisan key:generate to generate a new application key
4. Run sail artisan migrate:fresh --seed to (re)run all migrations and default seeder

run MinIO (in sail) for data storage

MinIO is a high-performance, S3-compatible object storage solution, we use it to store uploaded files and exports.

Note

MinIO is not required to run the application for local development.

# for local development only, if not using MinIO, add the following lines to your .env file:
UPLOADS_DRIVER=local
EXPORTS_DRIVER=local

See .env.example for more information on how to configure the application to use MinIO

1. If not done already, copy the environment variables to your .env file from the .env.example file.
2. Run sail up -d minio to start the MinIO server
3. Run sail artisan minio:setup to create the MinIO buckets
4. Browse to http://localhost:9001 for the MinIO dashboard
5. The default user/password combination is minioadmin / minioadmin

add local development .env vars

For development, the following env var settings wil be helpful:

# dev env vars:

# the local env uses mailpit, any from email adres will do
OUTBOX_SMTP_FROM=foo@bar.nl

# the application will accept any OTP when prompted
ONE_TIME_PASSWORD_DRIVER=fake

# jobs will by executed synchronously, no need to listen to any queues
QUEUE_CONNECTION=sync

# allows telescope from rendering css (/telescope)
CSP_ENABLED=false

run the application in your browser

1. Browse to http://localhost/ and see the login screen
2. The default seeded user/password combination is admin@minvws.nl / admin
3. You can use any 6 digits OTP code to login

Running tests in your dev-env

In order to run the test suite in your dev env. Simply use sail to run the quality assurance tests on your docker container:

# start by creating a test database (for phpunit tests in non-parallel mode)
$ sail composer reset-test-db

The tests do run in parallel mode. You need to reset the test databases only one time:

$ sail composer test-reset

From now on, you can always run the test suite.

$ sail composer quality

Or just the PHPUnit tests:

$ sail composer test

Running end-to-end tests

See the robot/README.md for instructions on setting up and running the end-to-end tests.

Building the manual

The manual is located in the manual folder and is built with Sphinx.

Feature flags

If you need to enable or disable feature flags, you can do so by setting these variables in your .env file:

NOTIFICATIONS_ENABLED=true|false
TERM_ENGINE_V2_ENABLED=true|false

All feature flags are documented in the config/app.php file features array.

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.

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