diff --git a/README.md b/README.md index d8aeffb4924e0331c858c9b7ed3190cf26835419..4c98080069f7994a6a563780bcc63edef15e5b8b 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,17 @@ -# DBP API Server Template +# Relay ESign Api -[GitLab](https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template) +[GitLab](https://gitlab.tugraz.at/dbp/relay/examples/relay-esign-api) -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: +This is an example implementation of the DBP Relay API for the [ESign App](https://gitlab.tugraz.at/dbp/esign/signature). -* 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/) -* A docker-compose based development environment -* Linter/Unittest integration +The full steps are described at the [ESign Software Page](https://dbp-demo.tugraz.at/site/software/esign.html). -## Documentation +<!-- +## Screenshot -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 -``` + +--> ## Development -```bash -# clone git repository -git clone https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template.git relay-api -cd relay-api - -# install dependencies (you need php and composer for this) -# you can also do this in the dev docker container (see below docker-dev link) -composer install -``` - Please open [docker-dev/README.md](./docker-dev/README.md) for more information.