Skip to content
Snippets Groups Projects
Commit c227cb78 authored by Reiter, Christoph's avatar Reiter, Christoph :snake:
Browse files

README: Update and clean up

Various things have changed in the meantime.
Instead of duplicating things just point to the documentation website
where possibe.
parent 9af98b3e
No related branches found
No related tags found
No related merge requests found
Pipeline #151941 failed
# DBP API Server Template
# DBP Relay API Server Template
[GitLab](https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template)
......@@ -6,34 +6,14 @@ This repository can be used as a template/starting point for your own API instan
It consists of a minimally configures Symfony application and development environment
and includes/integrates:
* The [dbp/api-core-bundle](https://gitlab.tugraz.at/dbp/dbp-api/api-core-bundle): Which provides authentication, some same base end points and entities and configuration for [api-platform](https://api-platform.com/)
* The [dbp/relay-core-bundle](https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle): Which provides the base functionality and ties everything together
* The [dbp/relay-auth-bundle](https://gitlab.tugraz.at/dbp/relay/dbp-relay-auth-bundle): Which provides authentication via OIDC
* A docker-compose based development environment
* Linter/Unittest integration
## Documentation
## Creating your own API Instance using this Template
The documentation is work in progress and currently exists in another repository which can be viewed here:
[Relay API Gateway](https://dbp-demo.tugraz.at/dev-guide/relay/)
It will be moved into this repository in the near future.
## Creating your own API instance and creating your own Bundle
* Fork this repository
* Run the docker-compose based development environment and test it
* Copy the "api-starter-bundle" repo and rename everything
* Add the new bundle to your API fork
## Installation
```bash
# install relay-server-template to path "relay-api" (you need php and composer for this)
composer create-project dbp/relay-server-template relay-api "dev-main"
cd relay-api
# install dependencies
composer install
```
See https://dbp-demo.tugraz.at/dev-guide/relay/getting_started/
## Development
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment