https://github.com/nens/brostar-api

BROSTAR simplifies the datamanegement of the Basis Registratie Ondergrond (BRO)
https://github.com/nens/brostar-api

Last synced: 4 days ago
JSON representation

BROSTAR simplifies the datamanegement of the Basis Registratie Ondergrond (BRO)

• Host: GitHub
• URL: https://github.com/nens/brostar-api
• Owner: nens
• License: mit
• Created: 2024-02-02T16:06:08.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T08:07:14.000Z (6 months ago)
• Last Synced: 2024-05-22T13:39:57.016Z (6 months ago)
• Language: Python
• Homepage:
• Size: 512 KB
• Stars: 2
• Watchers: 10
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# BROStar API

## Introduction

BROStar is a data management product for the Dutch *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 [[email protected]](mailto:[email protected]).

## Project description

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.

## Backend development instructions

To install for development:

    $ docker compose build

    $ docker compose pull

    $ pip install pre-commit  # Just needed once for your laptop.

    $ pre-commit install # Just needed once to make sure that pre-commit runs on each commit for this project

The development setup includes a postgres database and 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 django "migrate", "createsuperuser" stuff.

7) Create an organization, fill in the KvK, and optionally fill in authentication details.

8) Create a user profile for the superuser.

If a requirement has changed (either dependency in `pyproject.toml` or an extra development package in `requirements.in`:

    $ docker compose run --rm web pip-compile --extra=test \

      --output-file=requirements.txt dev-requirements.in pyproject.toml

    $ docker compose run ...same command... --upgrade  # to grab new versions

## Internal N&S server installation notes

This is a public project, so the actual server deployment scripts with the passwords and so are safely hidden away in https://github.com/nens/brostar-site :-) We're installed with docker compose on https://staging.brostar.nl and https://www.brostar.nl . See the readme of `brostar-site` for the internal deployment documentation.

Make releases with "zest.releaser" (`pip install zest.releaser` to install it). "fullrelease" updates the release date, does a `git tag` and updates the version number.

    $ fullrelease

## Build the documentation

We use mkdocs for documenting BROSTAR. To build the docs locally:

    $ cd docs

    $ python3 -m venv .venv

    $ .venv/bin/pip install -r requirements.txt

    $ mkdocs serve

The docs are then available on http://127.0.0.1:8000/`.

Github automatically builds the docs from `main` branch and uploads them to

https://docs.brostar.nl/