BROStar is a data management product for the Basis Registratie Ondergrond (BRO). The code for the backend is stored in this repository. It consists of an API for importing, storing, and delivering data. The backend is open source, and can be self-hosted. The frontend is developed and hosted by Nelen & Schuurmans. This is a web application created on top of the API, making the data management of BRO data very accessible. Interested? Contact info@nelen-schuurmans.nl.
The backend consists of an API with:
-
An import task endpoint. This can import all current data from a BRO domain based on a KvK and project number.
-
An upload task endpoint. This can send data to the BRO, with a JSON input of all relevant data. The API handles the transformation to XML format and the message traffic to and from the BRO.
-
Endpoints for all assets imported from the BRO.
To install for development:
$ docker-compose build
$ docker-compose pull
$ pip install pre-commit # Just needed once for your laptop.
It uses a database within docker-compose. TODO: add celery/redis.
Some instructions:
$ docker-compose up # Starts the site on localhost:8000
$ docker-compose run --rm web pytest
$ docker-compose run --rm web python manage.py migrate
$ pre-commit run --all # runs the formatter, checks, etc.
Do the regular migrate, createsuperuser stuff.
-
Create an organization, fill in the KvK, and optionally fill in authentication details.
-
Create a user profile for the superuser.