https://github.com/digital-blueprint/relay-educationalcredentials-bundle

https://github.com/digital-blueprint/relay-educationalcredentials-bundle

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/digital-blueprint/relay-educationalcredentials-bundle
• Owner: digital-blueprint
• License: agpl-3.0
• Created: 2023-05-08T11:22:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-10T04:16:48.000Z (4 months ago)
• Last Synced: 2024-08-10T05:25:57.966Z (4 months ago)
• Language: PHP
• Homepage: https://packagist.org/packages/dbp/relay-educationalcredentials-bundle
• Size: 624 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DbpRelayEducationalcredentialsBundle

Create *Verifiable Credentials* for your users:

- Diplomas for students

## Integration into the API Server

* Add the repository to your composer.json:

```json

    "repositories": [

        {

            "type": "vcs",

            "url": "[email protected]: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`:

```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:

```yaml

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.

```bash

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

composer update dbp/relay-educationalcredentials-bundle

```