https://github.com/digital-blueprint/relay-demo-api
Relay Demo API
https://github.com/digital-blueprint/relay-demo-api
Last synced: 3 months ago
JSON representation
Relay Demo API
- Host: GitHub
- URL: https://github.com/digital-blueprint/relay-demo-api
- Owner: digital-blueprint
- Archived: true
- Created: 2023-04-28T11:53:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T03:24:51.000Z (over 1 year ago)
- Last Synced: 2025-02-19T03:36:51.670Z (5 months ago)
- Language: PHP
- Size: 247 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DBP Relay API Server Template
[GitHub](https://github.com/digital-blueprint/relay-demo-api) |
[Packagist](https://packagist.org/packages/dbp/relay-demo-api)
[](https://github.com/digital-blueprint/relay-demo-api/actions/workflows/test.yml)
This repository can be used as a template/starting point for your own API instance.
It consists of a minimally configures Symfony application and development environment
and includes/integrates:
* The [dbp/relay-core-bundle](https://packagist.org/packages/dbp/relay-core-bundle): Which provides the base functionality and ties everything together
* The [dbp/relay-auth-bundle](https://packagist.org/packages/dbp/relay-auth-bundle): Which provides authentication via OIDC
* A docker-compose based development environment
* Linter/Unittest integration
## Creating your own API Instance using this Template
```bash
composer create-project dbp/relay-server-template relay-demo-api "dev-main"
cd relay-demo-api
composer require --with-all-dependencies dbp/relay-base-person-bundle
composer require --with-all-dependencies dbp/relay-base-organization-bundle
composer require --with-all-dependencies dbp/relay-dispatch-bundle
```
See https://handbook.digital-blueprint.org/relay/dev/getting_started for more information.
## Development
Please see [docker-dev/README.md](./docker-dev/README.md) for more information.