Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digital-blueprint/relay-checkin-bundle
Symfony bundle to handle check-ins to places and contact tracing for warning about COVID-19 cases.
https://github.com/digital-blueprint/relay-checkin-bundle
checkin dbp dbp-relay digital-blueprint
Last synced: about 2 months ago
JSON representation
Symfony bundle to handle check-ins to places and contact tracing for warning about COVID-19 cases.
- Host: GitHub
- URL: https://github.com/digital-blueprint/relay-checkin-bundle
- Owner: digital-blueprint
- Created: 2023-02-01T13:29:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T18:01:52.000Z (8 months ago)
- Last Synced: 2024-04-15T07:15:13.827Z (8 months ago)
- Topics: checkin, dbp, dbp-relay, digital-blueprint
- Language: PHP
- Homepage:
- Size: 785 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# DbpRelayCheckinBundle
[GitHub](https://github.com/digital-blueprint/relay-checkin-bundle) |
[Packagist](https://packagist.org/packages/dbp/relay-checkin-bundle) |
[Frontend Application](https://gitlab.tugraz.at/dbp/check-in/checkin) |
[Check-in Website](https://dbp-demo.tugraz.at/site/software/check-in.html)
[](https://github.com/digital-blueprint/relay-checkin-bundle/actions/workflows/test.yml)
This bundle handles check-ins to places and contact tracing for warning about COVID-19 cases.
You will need to install and set up the Digital Blueprint fork of [CampusQR](https://gitlab.tugraz.at/dbp/check-in/campus-qr),
the open source system for contact tracing at universities.
See [Check-in Website](https://dbp-demo.tugraz.at/site/software/check-in.html) for more information.
There is a corresponding frontend application that uses this API at [Check-in Frontend Application](https://gitlab.tugraz.at/dbp/check-in/checkin).
## Bundle installation
You can install the bundle directly from [packagist.org](https://packagist.org/packages/dbp/relay-checkin-bundle).
```bash
composer require dbp/relay-checkin-bundle
```
## Integration into the Relay API Server
* Add the bundle to your `config/bundles.php` in front of `DbpRelayCoreBundle`:
```php
...
Dbp\Relay\CheckinBundle\DbpRelayCheckinBundle::class => ['all' => true],
Dbp\Relay\CoreBundle\DbpRelayCoreBundle::class => ['all' => true],
];
```
* Run `composer install` to clear caches
## Configuration
The bundle has a `campus_qr_url` and a `campus_qr_token` 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_checkin.yaml` in the app with the following content:
```yaml
dbp_relay_checkin:
campus_qr_url: 'https://campusqr.your.domain'
# campus_qr_url: '%env(CAMPUS_QR_URL)%'
campus_qr_token: 'secret token'
# campus_qr_token: '%env(CAMPUS_QR_TOKEN)%'
```
If you were using the [DBP API Server Template](https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template)
as template for your Symfony application, then the configuration file should have already been generated for you.
To handle locking you need to [configure locking in the core bundle](https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle#bundle-config).
You also need to [configure the Symfony Messenger in the core bundle](https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle#bundle-config) to check out guests after a certain amount of time.
For more info on bundle configuration see .
## Roles
This bundle needs the roles `ROLE_SCOPE_LOCATION-CHECK-IN` and `ROLE_SCOPE_LOCATION-CHECK-IN-GUEST` assigned to the user
to get permissions for the api.