Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed port 8080 from localhost #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion TUTORIAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,19 @@ Your computer should now start up your local development environment. Don't worr

Open your browser type <http://localhost/> as address and hit enter, you should now see your common ground component up and running.

### Git

Note that making changes to the code base will already result in a new git status due to the automatic generation of some files when spinning your component in development mode.

![Terminal view $git status](./resources/tutorial/git-status-dev.png)

The files are as follows:
- helm / [componentcode] - [version] .tgz: Your component's helm repository
- helm / index.yaml: the index of the helm repositories present
- openapi.yaml: The specification according to the OpenAPI standard
- publiccode.yaml: description of your component according to the [publiccode standard](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/index.html)


### Trouble shooting
When spinning up components we make extensive use of the cashing of docker, and use volumes to represent server disks. When running in to unexpected trouble always remember to clear your local docker vm with the -a command (removing image cash)

Expand All @@ -59,7 +72,7 @@ $ docker volume prune
The Common Ground base component provides a bit more than just a development interface, it also includes an example application and a backend that automatically hooks into your api. For now we're just going to focus on our api, but is good to read up on all the features of the Common Ground base component here.

## Adding your own resources
You can now access your api at http://localhost:8080/, as you can see it's pre-loaded with some example resources. Let's replace them with your own resources!
You can now access your api at http://localhost/, as you can see it's pre-loaded with some example resources. Let's replace them with your own resources!

First let's remove the resources currently in the api, we can do that by just removing the resources form our code base, navigate to the folder where you stored your code and open the folder api/src/Entity , you can find the example entities (the symfony name for resources) there. Just delete all the php files in that folder.

Expand Down
2 changes: 1 addition & 1 deletion api/helm/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v1
appVersion: V1.0
description: '&#039;Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.&#039;'
description: 'Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.'
name: ce
version: 0.1.0
home: ce.zaakonline.nl
Expand Down
Binary file modified api/helm/ce-0.1.0.tgz
Binary file not shown.
10 changes: 5 additions & 5 deletions api/helm/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ entries:
ce:
- apiVersion: v1
appVersion: V1.0
created: "2021-01-14T14:46:52.8678241Z"
created: "2021-01-28T14:58:38.865824377Z"
description: '&#039;Naast deze JSON rest API is er ook een [graphql](/graphql)
interface beschikbaar.&#039;'
digest: 67f5258f658163d0bbce8589293e125ef8b65e75b07c070acac25c44183c2aad
digest: 48a337e8f1f383920f963c9a7f0fcb85757b85118c62ff8d849fd47b1adeba07
home: ce.zaakonline.nl
icon: ce.zaakonline.nl
name: ce
Expand All @@ -16,7 +16,7 @@ entries:
pc:
- apiVersion: v1
appVersion: V1.0
created: "2021-01-14T14:46:52.887833Z"
created: "2021-01-28T14:58:38.872051869Z"
description: Naast deze JSON rest API is er ook een [graphql](/graphql) interface
beschikbaar.
digest: c7147901327e4770036ade713906209f66fcc6c971f97db6ea945d8398123077
Expand All @@ -31,7 +31,7 @@ entries:
category: Database
apiVersion: v2
appVersion: 11.10.0
created: "2021-01-14T14:46:52.9016441Z"
created: "2021-01-28T14:58:38.876271967Z"
dependencies:
- name: common
repository: https://charts.bitnami.com/bitnami
Expand Down Expand Up @@ -60,4 +60,4 @@ entries:
urls:
- charts/postgresql-10.1.1.tgz
version: 10.1.1
generated: "2021-01-14T14:46:52.8210311Z"
generated: "2021-01-28T14:58:38.854484903Z"
2 changes: 1 addition & 1 deletion api/helm/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ settings:
version: V1.0
majorVersion: v1
id:
description: '&#039;Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.&#039;'
description: 'Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.'
type: component
repro: https://github.com/ConductionNL/commonground-example
demo: ce.zaakonline.nl
Expand Down
130 changes: 68 additions & 62 deletions api/public/schema/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ info:
- Docker Image: [online](https://hub.docker.com/repository/docker/conduction/ce-php)
- Datamodel: [postman](schema/ce.postman_collection.json) / [oas](schema/openapi.yaml) / [pdf](schema/datamodel.pdf) / [modelio (zip)](schema/Datamodel_Modelio.zip)

'Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.'
Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.

paths:
/audit_trails:
Expand Down Expand Up @@ -3093,59 +3093,6 @@ components:
name:
type: string
definitions:
ChangeLog-read:
properties:
id:
description: 'The UUID identifier of this object'
type: string
example: e2984465-190a-4562-829e-a8cca81aa35d
format: uuid
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line is suspicius'
maxLength: 2555
action:
description: ''
type: string
objectId:
description: ''
type: string
objectClass:
description: ''
type: string
version:
description: ''
type: int
data:
description: ''
type: array
username:
description: ''
type: string
session:
description: 'The moment this request was created'
type: string
maxLength: 255
dateCreated:
description: 'The moment this request was created'
type: string
format: date-time
example: '2021-01-14 14:47:30'
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
example: '2021-01-14 14:47:30'
required: []
ChangeLog-write:
properties:
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line is suspicius'
maxLength: 2555
required: []
AuditTrail-read:
properties:
id:
Expand Down Expand Up @@ -3250,12 +3197,12 @@ definitions:
description: 'The moment this request was created'
type: string
format: date-time
example: '2021-01-14 14:47:30'
example: '2021-01-28 14:58:46'
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
example: '2021-01-14 14:47:30'
example: '2021-01-28 14:58:46'
required: []
AuditTrail-write:
properties:
Expand All @@ -3265,15 +3212,74 @@ definitions:
example: 'This log line looks suspicius'
maxLength: 2555
required: []
ChangeLog-read:
properties:
id:
description: 'The UUID identifier of this object'
type: string
example: e2984465-190a-4562-829e-a8cca81aa35d
format: uuid
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line is suspicius'
maxLength: 2555
action:
description: ''
type: string
objectId:
description: ''
type: string
objectClass:
description: ''
type: string
version:
description: ''
type: int
data:
description: ''
type: array
username:
description: ''
type: string
session:
description: 'The moment this request was created'
type: string
maxLength: 255
dateCreated:
description: 'The moment this request was created'
type: string
format: date-time
example: '2021-01-28 14:58:46'
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
example: '2021-01-28 14:58:46'
required: []
ChangeLog-write:
properties:
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line is suspicius'
maxLength: 2555
required: []
tags:
-
name: ChangeLog
name: Example
description: |



-
name: AuditTrail
description: |
An resource representing a log line.

This entity represents a product that can be ordered via the OrderRegistratieComponent.
-
name: AuditTrail
name: ChangeLog
description: |
An resource representing a log line.

Expand All @@ -3284,15 +3290,15 @@ securityDefinitions:
authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog'
flow: implicit
scopes:
read: 'read right to the AuditTrail resource'
write: 'write right to the AuditTrail resource'
read: 'read right to the ChangeLog resource'
write: 'write right to the ChangeLog resource'
JWT-Token:
type: apiKey
in: header
name: Authorization
scopes:
read: 'read right to the AuditTrail resource'
write: 'write right to the AuditTrail resource'
read: 'read right to the ChangeLog resource'
write: 'write right to the ChangeLog resource'
host: irc.zaakonline.nl
servers:
-
Expand Down
2 changes: 1 addition & 1 deletion api/public/schema/publiccode.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ url: "https://github.com/ConductionNL/commonground-example"
landingURL: "ce.zaakonline.nl"
isBasedOn: "https://github.com/ConductionNL/Proto-component-commonground.git"
softwareVersion: "V1.0"
releaseDate: "2021-14-01"
releaseDate: "2021-28-01"
logo: ce.zaakonline.nl
monochromeLogo: img/logo-mono.svg

Expand Down
Binary file added resources/tutorial/git-status-dev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.