dbp / relay-nexus-bundle
A template bundle for the Relay API gateway
Installs: 2 454
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Type:symfony-bundle
Requires
- php: >=8.2
- ext-json: *
- api-platform/core: ^3.4 || ^4.1
- dbp/relay-core-bundle: ^0.1.190
- psr/log: ^1.1.4 || ^2.0 || ^3.0
- symfony/config: ^6.4
- symfony/console: ^6.4
- symfony/dependency-injection: ^6.4
- symfony/framework-bundle: ^6.4
- symfony/http-client: ^6.4
- symfony/http-client-contracts: ^3.5
- symfony/http-foundation: ^6.4
- symfony/http-kernel: ^6.4
- symfony/routing: ^6.4
- symfony/serializer: ^6.4
- typesense/typesense-php: ^5.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.50
- phpstan/phpstan: ^2.0.1
- phpstan/phpstan-phpunit: ^2.0.1
- phpstan/phpstan-symfony: ^2.0.1
- phpunit/phpunit: ^11.1
- symfony/browser-kit: ^6.4
- symfony/http-client: ^6.4
- symfony/monolog-bundle: ^3.10
- symfony/phpunit-bridge: ^7.2
- symfony/runtime: ^7.2
README
GitHub | Packagist | Frontend Application
The Nexus bundle provides an API for providing a desktop application merging multiple frontend activities.
There is a corresponding frontend application that uses this API at Nexus Frontend Application.
Bundle installation
You can install the bundle directly from packagist.org.
composer require dbp/relay-nexus-bundle
Bundle configuration
Add this file dbp_relay_nexus.yaml to your config/packages/ directory, e.g.:
dbp_relay_nexus: topics: - "https://server01.org/app/app.topic.metadata.json" - "https://server02.org/app/app.topic.metadata.json" - "https://server03.org/app/app.topic.metadata.json" typesense: api_url: "%env(NEXUS_TYPESENSE_API_URL)%" api_key: "%env(NEXUS_TYPESENSE_API_KEY)%" authorization: roles: ROLE_USER: 'user.get("ROLE_DEVELOPER")'
| variable | type | content |
|---|---|---|
| topics | array | strings are URLs to the topic.metatdada.json files of the apps |
| typsense | Settings for the internal connction to the typesense server | |
| api_url | string | Typesense API URL of the internal typesense server |
| api_key | string | typesense API key to create, query and delete typesense collections |
Automatic import into new collection
Run bin/console dbp:relay:nexus:generate:activities to create a new collection with currently available activities. If documents were imported, the alias is set to the latest import and obsolete collections are deleted.