dbp/relay-educationalcredentials-bundle

v0.1.6 2024-04-16 11:48 UTC

Requires

• php: >=8.1
• ext-json: *
• api-platform/core: ^2.7.11 || ^3.2
• dbp/relay-base-person-bundle: ^0.2.26
• dbp/relay-core-bundle: ^0.1.148
• guzzlehttp/guzzle: ^7.0
• psr/log: ^1.1.4 || ^2.0 || ^3.0
• symfony/config: ^5.4 || ^6.4
• symfony/dependency-injection: ^5.4 || ^6.4
• symfony/framework-bundle: ^5.4 || ^6.4
• symfony/http-foundation: ^5.4 || ^6.4
• symfony/http-kernel: ^5.4 || ^6.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.50
• phpstan/phpstan: ^1.10.59
• phpstan/phpstan-phpunit: ^1.3.16
• phpunit/phpunit: ^9.6.17
• symfony/browser-kit: ^5.4 || ^6.4
• symfony/http-client: ^5.4 || ^6.4
• symfony/monolog-bundle: ^3.10
• symfony/phpunit-bridge: ^5.4 || ^6.4
• vimeo/psalm: ^5.22.2

AGPL-3.0-or-later

README

Create Verifiable Credentials for your users:

• Diplomas for students

Integration into the API Server

• Add the repository to your composer.json:

    "repositories": [
        {
            "type": "vcs",
            "url": "[e-mail]:dbp/relay/dbp-relay-educationalcredentials-bundle.git"
        }
    ],

• Add the bundle package as a dependency:

composer require dbp/relay-educationalcredentials-bundle=dev-main

• Add the bundle to your config/bundles.php:

...
Dbp\Relay\EducationalcredentialsBundle\DbpRelayEducationalcredentialsBundle::class => ['all' => true],
DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true],
];

• Run composer install to clear caches

Configuration

The bundle has a issuer configuration value that you can specify in your app, either by hardcoding it, or by referencing an environment variable.

For this create config/packages/dbp_relay_educationalcredentials.yaml in the app with the following content:

dbp_relay_educationalcredentials:
  issuer: "did:ebsi:abc..."
  # issuer: '%env(VC_ISSUER)%'
  urlIssuer: "http://localhost:13080/1.0/credentials/issue"
  # urlIssuer: '%env(VC_URL_ISSUER)%'
  urlVerifier: "http://localhost:14080/1.0/credentials/verify"
  # urlIssuer: '%env(VC_URL_VERIFIER)%'

The value gets read in DbpRelayEducationalcredentialsExtension and passed when creating the ConfigService service.

For more info on bundle configuration see https://symfony.com/doc/current/bundles/configuration.html

Development & Testing

• Install dependencies: composer install
• Run tests: composer test
• Run linters: composer run lint
• Run cs-fixer: composer run cs-fix

Bundle dependencies

Don't forget you need to pull down your dependencies in your main application if you are installing packages in a bundle.

# updates and installs dependencies from dbp/relay-educationalcredentials-bundle
composer update dbp/relay-educationalcredentials-bundle