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

README: document how to add the bundle and how to copy it

parent 4103687c
No related branches found
No related tags found
No related merge requests found
Pipeline #105580 passed
......@@ -6,19 +6,52 @@ DBP API project.
When including this bundle into your DBP API server it will gain the following
features:
* TODO
* TODO
* ...
* profit
* A custom `./bin/console` command
* An example entity
* Various HTTP methods implemented for that entity
## Using the Bundle as a Template
* Copy the repo contents
* Adjust the project name in `composer.json`
* Invent a new PHP namespace and adjust it in all PHP files
* Rename `src/DbpStarterBundle` and `DependencyInjection/DbpStarterExtension` to match the new project name
## Integration into the API Server
TODO: add to composer, create configuration, note how to see if it works
* Add the repository to your composer.json:
```json
"repositories": [
{
"type": "vcs",
"url": "git@gitlab.tugraz.at:dbp/middleware/dbp-api/api-starter-bundle.git"
}
],
```
* Add the package to as a dependency:
```json
"require": {
...
"dbp/api-starter-bundle": "@dev",
...
},
```
* Add the bundle to your `config/bundles.php`:
```php
...
DBP\API\StarterBundle\DbpStarterBundle::class => ['all' => true],
DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true],
];
```
## Development & Testing
* Install dependencies: `composer install`
* Run tests: `composer test`
* Run linters: `composer run lint`
* Run cs-fixed: `composer run cs-fix`
\ No newline at end of file
* Run cs-fixer: `composer run cs-fix`
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment