generated from ConductionNL/Proto-component-commonground
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 0c7efaa
Showing
112 changed files
with
33,053 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# EditorConfig helps developers define and maintain consistent | ||
# coding styles between different editors and IDEs | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
# Change these settings to your own preference | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
# We recommend you to keep these unchanged | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.feature] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.js] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.json] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
[*.php] | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.sh] | ||
indent_style = tab | ||
indent_size = 4 | ||
|
||
[*.vcl] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[*.xml] | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.{yaml,yml}] | ||
indent_style = space | ||
indent_size = 4 | ||
trim_trailing_whitespace = false | ||
|
||
[.gitmodules] | ||
indent_style = tab | ||
indent_size = 4 | ||
|
||
[.php_cs{,.dist}] | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[.travis.yml] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[composer.json] | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[docker-compose{,.override}.{yaml,yml}] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[Dockerfile] | ||
indent_style = tab | ||
indent_size = 4 | ||
|
||
[package.json] | ||
indent_style = space | ||
indent_size = 2 | ||
|
||
[phpunit.xml{,.dist}] | ||
indent_style = space | ||
indent_size = 4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
CONTAINER_REGISTRY_BASE=quay.io/api-platform | ||
CONDUCTION_COMMONGROUND_BAG_APIKEY='e8a95365-3078-4b41-990a-e3de43cecd36' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
* text=auto eol=lf | ||
|
||
*.conf text eol=lf | ||
*.html text eol=lf | ||
*.ini text eol=lf | ||
*.js text eol=lf | ||
*.json text eol=lf | ||
*.md text eol=lf | ||
*.php text eol=lf | ||
*.sh text eol=lf | ||
*.yaml text eol=lf | ||
*.yml text eol=lf | ||
bin/console text eol=lf | ||
|
||
*.ico binary | ||
*.png binary | ||
|
||
.github export-ignore | ||
.travis.yml export-ignore | ||
LICENSE export-ignore | ||
README.md export-ignore | ||
update-deps.sh export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Contributor Code of Conduct | ||
|
||
See [https://api-platform.com/docs/extra/conduct]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# Contributing to API Platform | ||
|
||
First of all, thank you for contributing, you're awesome! | ||
|
||
To have your code integrated in the API Platform project, there is some rules to follow, but don't panic, it's easy! | ||
|
||
## Reporting Bugs | ||
|
||
If you happen to find a bug, we kindly request you to report it. However, before submitting it, please: | ||
|
||
* Check the [project documentation available online](https://api-platform.com/docs/) | ||
|
||
Then, if it appears that it's a real bug, you may report it using Github by following these 3 points: | ||
|
||
* Check if the bug is not already reported! | ||
* A clear title to resume the issue | ||
* A description of the workflow needed to reproduce the bug, | ||
|
||
> _NOTE:_ Don’t hesitate giving as much information as you can (OS, PHP version extensions...) | ||
## Pull Requests | ||
|
||
### Writing a Pull Request | ||
|
||
First of all, you must decide on what branch your changes will be based. If the changes your are going to make are | ||
fully backward-compatible, you should base your changes on the latest stable branch (`2.0` at the moment). | ||
Otherwise, you should base your changes on the `master` branch. | ||
|
||
### Matching Coding Standards | ||
|
||
The API Platform project follows [Symfony coding standards](https://symfony.com/doc/current/contributing/code/standards.html). | ||
But don't worry, you can fix CS issues automatically using the [PHP CS Fixer](http://cs.sensiolabs.org/) tool: | ||
|
||
```bash | ||
php-cs-fixer.phar fix | ||
``` | ||
|
||
And then, add fixed file to your commit before push. | ||
Be sure to add only **your modified files**. If another files are fixed by cs tools, just revert it before commit. | ||
|
||
### Sending a Pull Request | ||
|
||
When you send a PR, just make sure that: | ||
|
||
* You add valid test cases. | ||
* Tests are green. | ||
* You make a PR on the related documentation in the [api-platform/docs](https://github.com/api-platform/docs) repository. | ||
* You make the PR on the same branch you based your changes on. If you see commits | ||
that you did not make in your PR, you're doing it wrong. | ||
* Also don't forget to add a comment when you update a PR with a ping to [the maintainers](https://github.com/orgs/api-platform/people), | ||
so he/she will get a notification. | ||
* Squash your commits into one commit. (see the next chapter) | ||
|
||
All Pull Requests must include the following header: | ||
|
||
```markdown | ||
| Q | A | ||
| ------------- | --- | ||
| Bug fix? | yes/no | ||
| New feature? | yes/no | ||
| BC breaks? | no | ||
| Deprecations? | no | ||
| Tests pass? | yes | ||
| Fixed tickets | #1234, #5678 | ||
| License | MIT | ||
| Doc PR | api-platform/docs#1234 | ||
``` | ||
|
||
## Squash your Commits | ||
|
||
If you have 3 commits. So start with: | ||
|
||
```bash | ||
git rebase -i HEAD~3 | ||
``` | ||
|
||
An editor will be opened with your 3 commits, all prefixed by `pick`. | ||
|
||
Replace all `pick` prefixes by `fixup` (or `f`) **except the first commit** of the list. | ||
|
||
Save and quit the editor. | ||
|
||
After that, all your commits where squashed into the first one and the commit message of the first commit. | ||
|
||
If you would like to rename your commit message type: | ||
|
||
```bash | ||
git commit --amend | ||
``` | ||
|
||
Now force push to update your PR: | ||
|
||
```bash | ||
git push --force | ||
``` | ||
|
||
# License and Copyright Attribution | ||
|
||
When you open a Pull Request to the API Platform project, you agree to license your code under the [MIT license](LICENSE) | ||
and to transfer the copyright on the submitted code to Kévin Dunglas. | ||
|
||
Be sure to you have the right to do that (if you are a professional, ask your company)! | ||
|
||
If you include code from another project, please mention it in the Pull Request description and credit the original author. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/docker-compose.override.yaml | ||
/docker-compose.override.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
sudo: required | ||
|
||
services: | ||
- docker | ||
|
||
addons: | ||
apt: | ||
packages: | ||
- docker-ce | ||
|
||
before_install: | ||
- curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash -s -- --version v2.9.0 | ||
|
||
install: true | ||
|
||
before_script: | ||
- sudo service postgresql stop | ||
# wait for postgresql to shutdown | ||
- while sudo lsof -Pi :5432 -sTCP:LISTEN -t; do sleep 1; done | ||
|
||
script: | ||
- if jq '.extra.symfony.id != null' api/composer.json -e > /dev/null; then echo 'composer.json must not have symfony.id' 1>&2 && false; fi | ||
- docker-compose pull --ignore-pull-failures | ||
- docker-compose build --pull | ||
- docker-compose up -d | ||
- sleep 30 | ||
- docker-compose exec -T php composer req sensiolabs/security-checker | ||
- docker-compose exec -T php bin/console security:check | ||
- curl -f http://localhost # Client | ||
- curl -f http://localhost:81 # Admin | ||
- curl -f http://localhost:8080 # API | ||
- curl -f http://localhost:8081 # Varnish | ||
- curl -fk https://localhost # Client (HTTP/2) | ||
- curl -fk https://localhost:444 # Admin (HTTP/2) | ||
- curl -fk https://localhost:8443 # API (HTTP/2) | ||
- curl -fk https://localhost:8444 # Varnish (HTTP/2) | ||
- helm lint ./api/helm/api/ | ||
|
||
before_deploy: | ||
- echo "$DOCKER_PASSWORD" | docker login --username "$DOCKER_USERNAME" --password-stdin "$DOCKER_REGISTRY" | ||
|
||
deploy: | ||
provider: script | ||
script: docker-compose push | ||
skip_cleanup: true | ||
on: | ||
repo: api-platform/api-platform | ||
branch: master |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Design Considerations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) 2015-present Kévin Dunglas | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is furnished | ||
to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
<h1 align="center"><a href="https://common-ground.dev"><img src="https://common-ground.dev/logo-250x250.png" alt="Common Ground"></a></h1> | ||
|
||
Welkom the the VNG Common Ground proto component! | ||
|
||
This repository provides a plug and play solution for component generation on common ground. That means that it takes away all the husle of setting op codebases, containers and following the VNG Api Standaard. It does al that for you! | ||
|
||
For that we use **[Api Platform](https://api-platform.com)**, a next-generation web framework designed to easily create API-first projects without compromising extensibility | ||
and flexibility. | ||
|
||
[](https://travis-ci.org/api-platform/core) | ||
[](https://ci.appveyor.com/project/dunglas/dunglasapibundle) | ||
[](https://codecov.io/gh/api-platform/core) | ||
[](https://insight.sensiolabs.com/projects/92d78899-946c-4282-89a3-ac92344f9a93) | ||
[](https://scrutinizer-ci.com/g/api-platform/core/?branch=master) | ||
|
||
Features | ||
------- | ||
API Platform embraces open web standards (OpenAPI, JSON-LD, GraphQL, Hydra, HAL, JSONAPI, JWT, OAuth, HTTP...) and the [Linked Data](https://www.w3.org/standards/semanticweb/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](https://reactjs.org/) application, to provide face to your code | ||
* And a fully functional (and automaticly updated) [React Admin](https://marmelab.com/react-admin/) backend to easly test and proof your component | ||
* Design your own data model as plain old PHP classes or [**import an existing one**](https://api-platform.com/docs/schema-generator) | ||
from the [Schema.org](https://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](http://graphql.org), [JSON-LD](http://json-ld.org), [Hydra](http://hydra-cg.com), | ||
[HAL](http://stateless.co/hal_specification.html), [JSONAPI](https://jsonapi.org/), [YAML](http://yaml.org/), [JSON](http://www.json.org/), [XML](https://www.w3.org/XML/) and [CSV](https://www.ietf.org/rfc/rfc4180.txt) are supported out of the box | ||
* Enjoy the **beautiful automatically generated API documentation** (Swagger/[OpenAPI](https://www.openapis.org/)) | ||
* Add [**a convenient Material Design administration interface**](https://api-platform.com/docs/admin) built with [React](https://reactjs.org/) | ||
without writing a line of code | ||
* **Scaffold fully functional Progressive-Web-Apps and mobile apps** built with [React](https://api-platform.com/docs/client-generator/react), [Vue.js](https://api-platform.com/docs/client-generator/vuejs) or [React Native](https://api-platform.com/docs/client-generator/react-native) thanks to [the client | ||
generator](https://api-platform.com/docs/client-generator) (a Vue.js generator is also available) | ||
* Install a development environment and deploy your project in production using **[Docker](https://api-platform.com/docs/distribution#using-the-official-distribution-recommended)** and [Kubernetes](https://api-platform.com/docs/deployment/kubernetes) | ||
* Easily add **[JSON Web Token](https://api-platform.com/docs/core/jwt) or [OAuth](https://oauth.net/) authentication** | ||
* Create specs and tests with a **developer friendly API testing tool** on top of [Behat](http://behat.org/) | ||
* 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](http://www.doctrine-project.org/projects/orm.html) (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](https://packagist.org/packages/conduction/commongroundbundle) for symfony to provide common ground specific functionalty based on the [VNG Api Strategie](https://docs.geostandaarden.nl/api/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](https://packagist.org/packages/conduction/commongroundbundle) .... | ||
|
||
Be sure to alse read our [design considerations](/design.md) conserning the [VNG Api Strategie](https://docs.geostandaarden.nl/api/API-Strategie/). | ||
|
||
Getting started | ||
------- | ||
|
||
* Get your own commonent by simply forking this repository trough [generation](https://github.com/ConductionNL/commonground-component/generate). | ||
* Pull a local copy of your repository trough your favorite git client (e.g [gitkraken](https://www.gitkraken.com/) or [sourcetree](https://www.sourcetreeapp.com/)) | ||
* Start up you local instance with [docker for desktop](https://hub.docker.com/?overlay=onboarding) and the $ docker-compose up command | ||
* Open [http://localhost] in your favorite browser and view your component! | ||
|
||
Credits | ||
------- | ||
|
||
Created by [Ruben van der Linde](https://www.conduction.nl/team) for conduction. But bassed on [api platform](https://api-platform.com) by [Kévin Dunglas](https://dunglas.fr). Commercial support for commonground components available from [Conduction](https://www.conduction.nl). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Tutorial | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
**/*.log | ||
**/*.md | ||
**/._* | ||
**/.dockerignore | ||
**/.DS_Store | ||
**/.git/ | ||
**/.gitattributes | ||
**/.gitignore | ||
**/.gitmodules | ||
**/Dockerfile* | ||
**/Thumbs.db | ||
.env* | ||
build/ | ||
node_modules/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
REACT_APP_API_ENTRYPOINT=https://localhost:8443 |
Oops, something went wrong.