Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JJFlorian committed Mar 22, 2024
1 parent e924459 commit fbefe01
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@

## Introductie

BROStar is een allomvattend product voor het datamanagement rondom de BRO. Het bestaat uit een API om zowel data uit de BRO te importeren als data naar de BRO op te sturen. De geimporteerde data wordt opgeslagen in een database en is via de API op te vragen.
BROStar is een datamanagement product voor de Basis Registratie Ondergrond. In deze repository staat de code voor de backend. Deze bestaat uit een API om data te importeren, op te slaan en aan te leveren. De backend is open source, en kan dus zelf gehost worden. De frontend is ontwikkeld door Nelen & Schuurmans. Dit is een webapplicatie die op de API gemaakt is, welk het datamanagement van BRO data zeer laagdrempelig maakt. Interesse? Contact [email protected]

De backend is een Django applicatie, en de frontend (voorlopig) een Streamlit dashboard.

## Project beschrijving

De backend bestaat uit een api met daarin:

- Een importtask endpoint. Hiermee kan op basis van een KvK en projectnummer alle actuele data van een BRO domein geimporteerd worden

- Een uploadtask endpoint. Hiermee kan data naar de BRO gestuurd worden, met als input een json van alle relevante data. De api handelt de transformatie naar XML-formaat en het berichtenverkeer van en naar de BRO af.
- Een uploadtask endpoint. Hiermee kan data naar de BRO gestuurd worden, met als input een json van alle relevante data. De api handelt de transformatie naar XML-formaat en het berichtenverkeer van en naar de BRO af.

- Endpoints voor alle assets die uit de BRO worden geimporteerd.

Expand All @@ -35,8 +34,6 @@ Some instructions:

Do the regular migrate, createsuperuser stuff.

TODO: start celery automatically (`celery -A brostar worker -l INFO -P solo`)
7) Maak een organisatie, vul de KvK, en eventueel authenticatie gegevens in

7) Maak een organisatie, vul de KvK in

8) Maak een user profile aan voor de superuser, en vul het project en evt bro authenticatie in
8) Maak een user profile aan voor de superuser

0 comments on commit fbefe01

Please sign in to comment.