Composer Tools for Code Quality
To ensure code quality, run composer test to run the following:
Composer Tools for Code Quality
To ensure code quality, run composer test to run the following:
![](\\"https://ldog.apiskeletons.dev/logo.svg\\"){kind=logo}
\\n\\n\\n## Laravel, Doctrine ORM, and GraphQL\\n\\nThis is a template application for building GraphQL applications in\\nLaravel with Doctrine ORM. **Known as the LDOG (el-dog) Stack.**\\n\\nTo create a new project run\\n```\\ncomposer create-project api-skeletons/ldog\\n```\\n\\nSource code available at https://github.com/api-skeletons/ldog\\n\\nThis site is the ldog project running on Google Cloud. It includes an example\\nDoctrine ORM schema and database served as GraphQL.\\n\\nYou may explore the GraphQL with [graphiql](https://ldog.apiskeletons.dev/graphiql)\\nor POST to this server\'s GraphQL endpoint at https://ldog.apisketons.dev\\n\\n\\n## Features\\n\\n* Dockerfile suitable to immediate deployment to Cloud Run\\n* docker-compose.yml file - no Laravel Sail integration\\n* Doctrine ORM configured for XML metadata and no database naming strategy\\n* Includes the [api-skeletons/doctrine-orm-graphql](https://github.com/api-skeletons/doctrine-orm-graphql)\\n type driver\\n* The [GraphQLController](https://github.com/API-Skeletons/ldog/blob/main/app/Http/Controllers/GraphQLController.php)\\n is pre-configured with example endpoints for connection, entity, and mutation\\n* The Doctrine [entities](https://github.com/API-Skeletons/ldog/blob/main/app/Doctrine/ORM/Entity/Artist.php)\\n have default configuration for [api-skeletons/doctrine-orm-graphql](https://github.com/API-Skeletons/doctrine-orm-graphql)\\n* Authorization provided by [api-skeletons/laravel-doctrine-apikey](https://github.com/API-Skeletons/laravel-doctrine-apikey)\\n and [laravel/passort](https://laravel.com/docs/10.x/passport)\\n* The Laravel code has been modified so the entire project passes the\\n [Doctrine Coding Standard](https://www.doctrine-project.org/projects/doctrine-coding-standard/en/11.0/reference/index.html)\\n* Code quality tools include parallel-lint, phpcs, psalm, and phpunit\\n* An unit test is included that tests the GraphQL endpoints\\n\\n\\n## Why use this template application?\\n\\nThis template application is based on Laravel 10.x. Nothing has been taken away from that\\ndefault Laravel release but a lot has been added.\\n\\nThere are many GraphQL solutions available including those that integrate with Laravel\\nand Eloquent. But Doctrine ORM is the superior ORM because it is a\\n[data mapper pattern](https://www.thoughtfulcode.com/orm-active-record-vs-data-mapper/).\\n\\nThe [doctrine-orm-graphql](https://github.com/api-skeletons/doctrine-orm-graphql) library\\ncreates the types for your Doctrine entities and has numerous other features.\\n\\nA [Skipper](https://skipper18.com) diagram is included and the example database metadata\\nis exported from it as XML. The advantages of XML metadata over annotations or attributes\\nare many and not needing to edit the XML manually is a big benefit.\\n\\n\\n## Convert an existing database to GraphQL\\n\\nUsing skipper, import a new external model and import your database. Change the\\nExport Data Format to XML and set the path to `~/config/doctrine-orm-metadata`.\\nExport from Skipper and build your entities. Turn on `globalEnable` in the driver\\nand create at least one endpoint.\\n\\n\\n## Support\\n\\nSupport for this template application is available through\\n[API Skeletons](mailto:contact@apiskeletons.com).\\n"},{"title":"Getting Started","content":"# Getting Started\\n\\n* Copy `.env.example` or `.env.dev` to `.env`\\n* Run `docker-compose up -d`\\n* Connect to the docker instance by running `docker ps` to get the instance id,\\n then `docker exec -it {instanceId} bash`\\n* Run `composer install`\\n* Create the database with `php artisan doctrine:schema:create`\\n* Generate the GraphQL documentation with `magidoc generate`\\n\\n---\\n\\nA project of [API Skeletons](mailto:contact@apiskeletons.com)\\n* https://github.com/api-skeletons/ldog\\n"},{"title":"Security","content":"Security\\n========\\n\\nThe security of your data is important to us. We have implemented industry standard security\\nmeasures to protect your data.\\n\\nBoth API Key and OAuth2 are supported for authentication.\\n\\nAPI Key\\n-------\\n\\nTo test API Key security, POST to https://ldog.apiskeletons.dev/apikey with the following header:\\n\\n```\\nAuthorization: Bearer HkwFkpby6MXJOnpC5QAb1Z4N1o2QmkSsXQPXOkMi0NgTU6Y6zcAgymm5AWJ7GGCV\\n```\\n\\nAPI Key security is implemented with https://github.com/API-Skeletons/laravel-doctrine-apikey\\nSee the documentation for that package for more information.\\n\\n\\nOAuth2\\n------\\n\\nTo test OAuth2 security, POST to https://ldog.apiskeletons.dev/oauth/token\\n\\nAdmittedly, configuration of OAuth2 can be extensive. But the ability to include both\\nPassport and [api-skeletongs/doctrine-orm-graphql](https://github.com/API-Skeletons/doctrine-orm-graphql)\\nin the same project is a powerful combination.\\n\\n---\\n\\nA project of [API Skeletons](mailto:contact@apiskeletons.com)\\n* https://github.com/api-skeletons/ldog\\n"}]},{"title":"Database Quality","content":[{"title":"Doctrine ERD with Skipper","content":"# Doctrine ERD with Skipper\\n\\nIncluded is an ERD you can use to extend your project\'s database. The ERD is created with [Skipper](https://skipper18.com).\\nFind it at `~/ldog.skipper`. The export path is set to `~/config/doctrine-orm-metadata`.\\n\\nThis an an immensely powerful tool and every Doctrine ORM project should use it.\\n\\nThis is the ERD for the entities used in developing the stack.\\n\\n\\n\\n# The LDOG Stack for PHP\\n\\n## Laravel, Doctrine ORM, and GraphQL\\n\\nThis is a template application for building GraphQL applications in\\nLaravel with Doctrine ORM. **Known as the LDOG (el-dog) Stack.**\\n\\nTo create a new project run\\n```\\ncomposer create-project api-skeletons/ldog\\n```\\n\\nSource code available at https://github.com/api-skeletons/ldog\\n\\nThis site is the ldog project running on Google Cloud. It includes an example\\nDoctrine ORM schema and database served as GraphQL.\\n\\nYou may explore the GraphQL with [graphiql](https://ldog.apiskeletons.dev/graphiql)\\nor POST to this server\'s GraphQL endpoint at https://ldog.apisketons.dev\\n\\n\\n## Features\\n\\n* Dockerfile suitable to immediate deployment to Cloud Run\\n* docker-compose.yml file - no Laravel Sail integration\\n* Doctrine ORM configured for XML metadata and no database naming strategy\\n* Includes the [api-skeletons/doctrine-orm-graphql](https://github.com/api-skeletons/doctrine-orm-graphql)\\n type driver\\n* The [GraphQLController](https://github.com/API-Skeletons/ldog/blob/main/app/Http/Controllers/GraphQLController.php)\\n is pre-configured with example endpoints for connection, entity, and mutation\\n* The Doctrine [entities](https://github.com/API-Skeletons/ldog/blob/main/app/Doctrine/ORM/Entity/Artist.php)\\n have default configuration for [api-skeletons/doctrine-orm-graphql](https://github.com/API-Skeletons/doctrine-orm-graphql)\\n* Authorization provided by [api-skeletons/laravel-doctrine-apikey](https://github.com/API-Skeletons/laravel-doctrine-apikey)\\n and [laravel/passort](https://laravel.com/docs/10.x/passport)\\n* The Laravel code has been modified so the entire project passes the\\n [Doctrine Coding Standard](https://www.doctrine-project.org/projects/doctrine-coding-standard/en/11.0/reference/index.html)\\n* Code quality tools include parallel-lint, phpcs, psalm, and phpunit\\n* An unit test is included that tests the GraphQL endpoints\\n\\n\\n## Why use this template application?\\n\\nThis template application is based on Laravel 10.x. Nothing has been taken away from that\\ndefault Laravel release but a lot has been added.\\n\\nThere are many GraphQL solutions available including those that integrate with Laravel\\nand Eloquent. But Doctrine ORM is the superior ORM because it is a\\n[data mapper pattern](https://www.thoughtfulcode.com/orm-active-record-vs-data-mapper/).\\n\\nThe [doctrine-orm-graphql](https://github.com/api-skeletons/doctrine-orm-graphql) library\\ncreates the types for your Doctrine entities and has numerous other features.\\n\\nA [Skipper](https://skipper18.com) diagram is included and the example database metadata\\nis exported from it as XML. The advantages of XML metadata over annotations or attributes\\nare many and not needing to edit the XML manually is a big benefit.\\n\\n\\n## Convert an existing database to GraphQL\\n\\nUsing skipper, import a new external model and import your database. Change the\\nExport Data Format to XML and set the path to `~/config/doctrine-orm-metadata`.\\nExport from Skipper and build your entities. Turn on `globalEnable` in the driver\\nand create at least one endpoint.\\n\\n\\n## Support\\n\\nSupport for this template application is available through\\n[API Skeletons](mailto:contact@apiskeletons.com).\\n"},{"title":"Getting Started","content":"# Getting Started\\n\\n* Copy `.env.example` or `.env.dev` to `.env`\\n* Run `docker-compose up -d`\\n* Connect to the docker instance by running `docker ps` to get the instance id,\\n then `docker exec -it {instanceId} bash`\\n* Run `composer install`\\n* Create the database with `php artisan doctrine:schema:create`\\n* Generate the GraphQL documentation with `magidoc generate`\\n\\n---\\n\\nA project of [API Skeletons](mailto:contact@apiskeletons.com)\\n* https://github.com/api-skeletons/ldog\\n"},{"title":"Security","content":"Security\\n========\\n\\nThe security of your data is important to us. We have implemented industry standard security\\nmeasures to protect your data.\\n\\nBoth API Key and OAuth2 are supported for authentication.\\n\\nAPI Key\\n-------\\n\\nTo test API Key security, POST to https://ldog.apiskeletons.dev/apikey with the following header:\\n\\n```\\nAuthorization: Bearer HkwFkpby6MXJOnpC5QAb1Z4N1o2QmkSsXQPXOkMi0NgTU6Y6zcAgymm5AWJ7GGCV\\n```\\n\\nAPI Key security is implemented with https://github.com/API-Skeletons/laravel-doctrine-apikey\\nSee the documentation for that package for more information.\\n\\n\\nOAuth2\\n------\\n\\nTo test OAuth2 security, POST to https://ldog.apiskeletons.dev/oauth/token\\n\\nAdmittedly, configuration of OAuth2 can be extensive. But the ability to include both\\nPassport and [api-skeletongs/doctrine-orm-graphql](https://github.com/API-Skeletons/doctrine-orm-graphql)\\nin the same project is a powerful combination.\\n\\n---\\n\\nA project of [API Skeletons](mailto:contact@apiskeletons.com)\\n* https://github.com/api-skeletons/ldog\\n"}]},{"title":"Database Quality","content":[{"title":"Doctrine ERD with Skipper","content":"# Doctrine ERD with Skipper\\n\\nIncluded is an ERD you can use to extend your project\'s database. The ERD is created with [Skipper](https://skipper18.com).\\nFind it at `~/ldog.skipper`. The export path is set to `~/config/doctrine-orm-metadata`.\\n\\nThis an an immensely powerful tool and every Doctrine ORM project should use it.\\n\\nThis is the ERD for the entities used in developing the stack.\\n\\n