Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
dbp-relay-example-bundle
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
digital blueprint
Relay API Gateway
dbp-relay-example-bundle
Commits
118c51e7
Commit
118c51e7
authored
4 years ago
by
Reiter, Christoph
Browse files
Options
Downloads
Patches
Plain Diff
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
4 years ago
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+39
-6
39 additions, 6 deletions
README.md
with
39 additions
and
6 deletions
README.md
+
39
−
6
View file @
118c51e7
...
...
@@ -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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment