Skip to content
Snippets Groups Projects
Select Git revision
  • 2701fb230ca8cf51b50f4fb287241cecd670b13c
  • main default protected
  • ci-test
  • v0.1.4
  • v0.1.3
  • v0.1.2
  • v0.1.1
  • v0.1.0
8 results

dbp-relay-server-template

  • Clone with SSH
  • Clone with HTTPS
  • Christoph Reiter's avatar
    Reiter, Christoph authored
    should be fixed now
    2701fb23
    History

    DBP API Server Template

    GitLab

    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/api-core-bundle: Which provides authentication, some same base end points and entities and configuration for api-platform
    • A docker-compose based development environment
    • Linter/Unittest integration

    Documentation

    The documentation is work in progress and currently exists in another repository which can be viewed here: Relay API Gateway

    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

    # 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

    # 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 for more information.