License and contributing

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Bijdragen aan OpenServices
+
+Wij waarderen uw interesse om bij te dragen aan OpenServices! OpenServices is een gemeenschapsgericht project dat streeft naar verbetering en uitbreiding met de hulp van ontwikkelaars, gebruikers en enthousiastelingen in de overheidstechnologie. Hier vindt u richtlijnen over hoe u kunt bijdragen.
+
+## Hoe kan ik bijdragen?
+
+Er zijn verschillende manieren waarop u kunt bijdragen aan OpenServices, waaronder:
+
+- **Bug rapporten:** Als u een bug vindt, kunt u deze melden via onze GitHub issues pagina.
+- **Feature verzoeken:** Heeft u ideeën voor nieuwe functies of verbeteringen? Voel u vrij om ze te delen als een issue.
+- **Code bijdragen:** Wij verwelkomen pull requests. Zie de sectie 'Pull Requests' hieronder voor meer informatie.
+- **Documentatie:** Verbeteringen aan de documentatie zijn altijd welkom, of het nu gaat om het corrigeren van typefouten of het toevoegen van nieuwe inhoud.
+
+## Gedragscode
+
+Dit project en iedereen die bijdraagt, is gebonden aan onze Gedragscode. Door deel te nemen, wordt van u verwacht dat u deze code respecteert. Vind onze Gedragscode in het bestand CODE_OF_CONDUCT.md in onze repository.
+
+## Bug rapporten
+
+Een bug wordt gedefinieerd als een *objectieve, verifieerbare fout*. Voordat u een bug rapport indient, zorg ervoor dat u de volgende stappen hebt gevolgd:
+
+1. Update naar de meest recente versie van OpenServices om te zien of het probleem nog steeds bestaat.
+2. Zoek in de issue tracker om te zien of de bug al is gerapporteerd. Als dit het geval is, voeg dan eventuele extra opmerkingen toe aan de bestaande rapportage.
+
+In uw rapport, geef alstublieft een duidelijke beschrijving van het probleem, inclusief stappen om het te reproduceren, en, indien mogelijk, een korte demonstratie van het probleem.
+
+## Pull Requests
+
+Voor het indienen van uw werk, volg deze stappen:
+
+1. Fork de repository en creëer uw branch vanuit `master`.
+2. Als u nieuwe code toevoegt, schrijf dan tests die uw wijzigingen dekken.
+3. Zorg ervoor dat uw code lints (code stijlcontroles) passeert.
+4. Update de documentatie, indien nodig.
+5. Dien een pull request in met een duidelijke beschrijving van uw wijzigingen.
+
+## Licentie
+
+Door bij te dragen aan OpenServices, gaat u ermee akkoord dat uw bijdragen worden gelicentieerd onder dezelfde MIT Licentie als het project.
+
+## Vragen?
+
+Heeft u vragen of feedback, neem dan contact op via [email protected].
+
+Bedankt voor uw interesse in het verbeteren van OpenServices!
+
+---
+
+Dit `CONTRIBUTING.md` bestand biedt een basis voor hoe externe bijdragers kunnen deelnemen aan het project. Afhankelijk van de specifieke behoeften en beleid van OpenServices, kunnen aanvullende secties worden toegevoegd, zoals specifieke coding conventies, testrichtlijnen, en meer gedetailleerde instructies voor het indienen van pull requests.

LICENSE.md

@@ -0,0 +1,7 @@
+# Licentie EUPL 1.2
+
+De OpenWoo.app is een project dat gelicentieerd is onder de Europese Unie Public Licence (EUPL). De EUPL is een open-source licentie die is goedgekeurd door de Europese Commissie. Deze licentie biedt een sterke juridische basis om ervoor te zorgen dat de software vrij en open blijft, en is ontworpen om compatibel te zijn met andere licenties zoals de GNU General Public License (GPL).
+
+Door het gebruik van de EUPL, geeft OpenWoo.app aan dat het project gecommitteerd is aan het behouden van een open en collaboratieve omgeving. Gebruikers en ontwikkelaars hebben de vrijheid om de software te gebruiken, te wijzigen, en te delen, zolang zij zich houden aan de voorwaarden die in de licentie zijn gesteld. Dit omvat, maar is niet beperkt tot, het behoud van de licentie-informatie en de auteursrechtkennisgevingen wanneer de software wordt gedistribueerd, of wanneer afgeleide werken worden gecreëerd.
+
+De EUPL-licentie ondersteunt de juridische en operationele grondslagen van open-source projecten, en draagt bij aan het algemene doel van het bevorderen van softwarevrijheid en samenwerking in de gemeenschap.

README.md

@@ -1,3 +1,52 @@
-# OpenRegisters.app
+# OpenRegisters
+
+## Over OpenRegisters
+
+OpenRegisters is een innovatief framework gebaseerd op Symfony, ontworpen om zowel object storage als API's op een fenomenaal snelle wijze te bieden. Dit wordt bereikt door binnenkomende objecten direct op te slaan in een object store (zoals MongoDB, CouchDB, Amazon S3, en de Google en Azure varianten daarvan), in plaats van in traditionele relationele databases. Hierdoor kunnen registers functioneren als 'adaptors' bovenop een open source object store, wat leidt tot een reeks van voordelen voor overheidsinstanties.
+
+## Kernvoordelen
+
+- **Efficiëntie en Snelheid:** Door gebruik te maken van object stores, biedt OpenRegisters snellere dataopslag en -toegang.
+- **Onderhoud en Ontwikkeling:** API's zoals ZGW zijn compacter, waardoor ze sneller en eenvoudiger te onderhouden en te ontwikkelen zijn.
+- **Federatie:** Volledige ondersteuning voor federatie via NLX/FSC, wat compatibiliteit met federale systemen waarborgt.
+- **Virtuele Registers:** Mogelijkheid om meerdere losse registers te combineren tot één virtueel register, essentieel voor projecten zoals OpenWoo.app en OpenCatalogi.nl.
+- **Gedeelde Functionaliteit:** Inclusief logging en verwerking, autorisatie & authenticatie, notificatie, filtering, en uitbreidbaarheid voor alle registers.
+- **Federaal Doovragen:** Ondersteunt het opvragen van gegevens uit één register via een ander, zoals de integratie van BRP-gegevens bij klantbevragingen.
+- **Importeren van VNG API specificaties:** Door de ondersteuning van OAS3 kunnen door de VNG opgestelde API specifiacties reachtreeks worden geimporteerd en uitgeleverd 
+- **Lage beheer, implementatie en hosting kosten:** Doordat Open Register ieder register als adaptor ziet in plaats van een volledige applicatie kunnen er gemakkenlijk meerdere regsiters worden geleverd vanuit één installatie.  
+- **Multi tenant:** Geavenceerde mogenlijkheid om meerdere tenants (organisaties) vanuit één installatie te draaien maakt open registers die ideele oplossing voor (SAAS) leveranciers en samenwerkings verbanden. 
+- *Gemaakt voor GROTE data sets:** OpenRegisters is speciaal ontworpen om efficiënt om te gaan met grote hoeveelheden data. Het maakt gebruik van de schaalbaarheid en snelheid van object storage om grote datasets snel en betrouwbaar te verwerken, waardoor het ideaal is voor overheidsregisters die te maken hebben met aanzienlijke hoeveelheden informatie.
+- *Snel als bliksem:** De architectuur van OpenRegisters, in combinatie met de backend van object storage, zorgt voor ongeëvenaarde snelheden bij dataopslag en -toegang. Dit resulteert in een snellere respons voor eindgebruikers en efficiëntere datahandeling, wat cruciaal is voor de prestaties van overheidsdiensten.
+
+## Installatie
+
+### Locale Installatie
+#### Vereisten
+
+- PHP 7.4 of hoger
+- Symfony 5 of hoger
+- Toegang tot een ondersteunde object store (MongoDB, CouchDB, Amazon S3, Google Cloud Storage, Azure Blob Storage)
+
+#### Stap-voor-stap Installatie
+
+1. Clone het OpenRegisters repository: `git clone https://github.com/ConductionNL/OpenRegisters.git`
+2. Installeer de benodigde afhankelijkheden: `composer install`
+3. Configureer uw omgevingsvariabelen (.env) met de nodige gegevens voor uw object store.
+4. Volg de specifieke configuratie-instructies voor de gekozen object store.
+
+## Gebruik
+
+Na installatie en configuratie kunt u beginnen met het definiëren van uw registers binnen OpenRegisters. Dit houdt in dat u de structuur van uw data en de API-endpoints specificeert, waarna OpenRegisters de rest afhandelt.
+
+## Bijdragen
+
+Bijdragen aan OpenRegisters is welkom! Of het nu gaat om het rapporteren van een bug, het voorstellen van een nieuwe feature, of het indienen van code wijzigingen, bekijk onze `CONTRIBUTING.md` voor meer informatie over hoe u kunt bijdragen.
+
+## Licentie
+
+OpenRegisters is uitgegeven onder een EUPL 1.2 licentie. Zie het (`LICENSE.md`)[`LICENSE.md`] bestand in onze GitHub repository voor meer details.
+
+## Contact
+
+Voor meer informatie over OpenRegisters en hoe u het kunt inzetten binnen uw organisatie, neem contact met ons op via [email protected].
 
-OpenRegisters.app is een framework voor het gemmakenlijk en snel ontwikkelen en onderhouden van registers binnen het commonground ecosysteem. Het doet dit door registers configureerbaar te maken.