Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 5.24 KB

README.md

File metadata and controls

67 lines (51 loc) · 5.24 KB
Raw

Readme

Welcome to the the VNG Common Ground proto component!

This "proto" component provides a plug and play solution for component generation on Common Ground. That means that it takes away all the hassle of setting op codebases, containers and following the VNG Api Standaard. It does all that for you!

For that we use Api Platform, a next-generation web framework designed to easily create API-first projects, without compromising extensibility and flexibility.

Features

API Platform embraces open web standards (OpenAPI, JSON-LD, GraphQL, Hydra, HAL, JSONAPI, JWT, OAuth, HTTP...) and the Linked Data movement. Your API will automatically expose structured data in Schema.org/JSON-LD. It means that your commonground application is usable out of the box with technologies of the semantic web.

  • Comes with a paired React application, to provide face to your code
  • And a fully functional (and automatically updated) React Admin backend to easily test and proof your component
  • Design your own data model as plain old PHP classes or import an existing one from the Schema.org vocabulary
  • Expose in minutes a hypermedia REST or a GraphQL API with pagination, data validation, access control, relation embedding, filters and error handling...
  • Benefit from Content Negotiation: GraphQL, JSON-LD, Hydra, HAL, JSONAPI, YAML, JSON, XML and CSV are supported out of the box
  • Enjoy the beautiful automatically generated API documentation (Swagger/OpenAPI)
  • Add a convenient Material Design administration interface built with React without writing a line of code
  • Scaffold fully functional Progressive-Web-Apps and mobile apps built with React, Vue.js or React Native thanks to the client generator (a Vue.js generator is also available)
  • Install a development environment and deploy your project in production using Docker and Kubernetes
  • Easily add JSON Web Token or OAuth authentication
  • Create specs and tests with a developer friendly API testing tool on top of Behat
  • use thousands of Symfony bundles and React components with API Platform
  • reuse all your Symfony and React skills, benefit of the incredible amount of documentation available
  • enjoy the popular Doctrine ORM (used by default, but fully optional: you can use the data provider you want, including but not limited to MongoDB and ElasticSearch)

The commonground bundle

This repository uses the power of conductions commonground bundle for symfony to provide common ground specific functionality based on the VNG Api Strategie. Including

  • Build in support for public API's like BAG (Kadaster), KVK (Kamer van Koophandel)
  • Build in validators for common dutch variables like BSN (Burger service nummer), RSIN(), KVK(), BTW()
  • AVG and VNG proof audit trails
  • And muchs more ....

Be sure to read our design considerations concerning the VNG Api Strategie.

Getting started

  • Get your own component by simply forking this repository through generation.
  • Pull a local copy of your repository trough your favorite git client (e.g gitkraken or sourcetree)
  • Start up you local instance with docker for desktop and the $ docker-compose up command
  • Open [http://localhost] in your favorite browser and view your component!

Requesting features

Do you need a feature that is not on this list? don't hesitate to send us a feature request.

Staying up to date

Credits

Created by Ruben van der Linde for conduction. But based on api platform by Kévin Dunglas. Commercial support for common ground components available from Conduction.