BuilderLibraryMarketplace

Create production envieronment

Define the final environment open for users
Environment name
Envieronment advanced settings
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4
Production environment is payed feature, it follows the fair revenue split.
I agree with the shared revenue model
Automation
Envieronments
Development
Running
StagingDeploying
Testing
Never deployed
Environment settings
Create ProductionCreate Feature Branch
Environment settings
Reserved area for environment settings
Core module
Service settings
BiFrost is an API gateway and core authentication layer for microservice architectures. It registers every endpoint from the logic modules through an auto-discovery process and combines them into a single API.
v 2.3.15
28 Mar 2019
Configure
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
Reserved area for the module configuration.

Products service (Django)

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Backend logic modules

Image Recognition Module

by Ralf Kostulski
v 1.8.11
May 22, 2019
Update
by Ralf Kostulski
Add image recognition with basic feature detection and matching algorithms.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

E-Mail Module

by Ralf Kostulski
v 1.0.0
May 22, 2019
Update
by Ralf Kostulski
You can add E-Mail sending through your sendgrid account with this service.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Forms

by Humanitec GmbH
v 5.0.2
May 5, 2019
Update
by Humanitec GmbH
The forms service provides the backend for a forms creation and responses management for your app. It exposes the forms data models.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Products

by Humanitec GmbH
v 0.9.6
May 20, 2019
Update
by Humanitec GmbH
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

FSociety Logic Module

by Elliot Alderson
v 0.3.11
May 19, 2019
Update
by Elliot Alderson
A Penetration testing service, you will have every script that a hacker need.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Dashboard

by Humanitec GmbH
v 2.1.1
Jan 7, 2019
Update
by Humanitec GmbH
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Punchy Logic Module client

by Mike Tyson
15 Mar 2019

Custom Django module

by UserName
v 0.0.0
Now

Add new service module

Browse marketplace
––– or –––
Create custom module
Core module
Client settings
Midgard-Angular is a customizable web application that provides an interface for the microservices in your Walhall application. It comes pre-configured to communicate with your application’s API.
v 1.3.15
12 Mar 2019
Angular
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
Reserved area for the module configuration.

Products service (Django)

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Frontend logic modules

E-Mail Module

by Ralf Kostulski
v 1.0.0
May 22, 2019
Update
by Ralf Kostulski
You can add E-Mail sending through your sendgrid account with this service.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Forms

by Humanitec GmbH
v 5.0.2
May 5, 2019
Update
by Humanitec GmbH
The forms service provides the backend for a forms creation and responses management for your app. It exposes the forms data models.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Products

by Humanitec GmbH
v 0.9.6
May 20, 2019
Update
by Humanitec GmbH
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
New version of logic module is available. See the change log
Update
Roll back version
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Default
Clone
Install
Build
build-docker-image-tag
0Initialized empty Git repository in /drone/src/.git/
1+ git fetch origin +refs/tags/v0.3.13:
2From https://github.com/buryatsky/resources-manager-frontend
3* tag v0.3.13 -> FETCH_HEAD
4+ git checkout -qf FETCH_HEAD
01data:
02 ALLOWED_HOSTS: ‘*’
03 AWS_ACCESS_KEY_ID: AKIAIVUUZ3FXPSA64ZOQ
04 AWS_SECRET_ACCESS_KEY: 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
05 AWS_STORAGE_BUCKET_NAME: kupfer-documents-dev
06 CORS_ORIGIN_WHITELIST: ‘*’
07 DATABASE_ENGINE: postgresql
08 DATABASE_HOST: 127.0.0.1
09 DATABASE_NAME: db-fd11e056-cff4-4368-bb13-80e1eced2d59
10 DATABASE_PORT: “5432”
11 JWT_ISSUER: bifrost
12 SECRET_KEY: m+zra8q0ych&_dzckpd5c9t&kj!_7*!7vc)nm)djzngxv+swyd
13kind: ConfigMap
14metadata:
15creationTimestamp: 2019-04-30T08:28:43Z
16name: products-service-config-map
17namespace: 2df3f4fa-9f54-435b-a07a-61d20d6d35fc
18resourceVersion: “3705835"
19selfLink: /api/v1/namespaces/2df3f4fa-9f54-435b-a07a-61d20d6d35fc/configmaps/products-service-config-map
20uid: f72ea2d0-6b21-11e9-aff1-42010a9a0fc4

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Add new client module

Browse marketplace
––– or –––
Create custom module