@@ -8,7 +8,7 @@ export default {
88 output : './public/docs' ,
99 options : {
1010 siteRoot : `/docs` ,
11- appTitle : 'Laravel, Doctrine ORM, and GraphQL ' ,
11+ appTitle : 'ldog Stack ' ,
1212 appLogo : 'https://raw.githubusercontent.com/API-Skeletons/ldog/main/public/ldog.svg' ,
1313 appFavicon : 'https://apiskeletons.com/images/favicon.ico' ,
1414 pages : [
@@ -29,32 +29,32 @@ export default {
2929 "
3030/>
3131
32- Laravel, Doctrine ORM, and GraphQL Stack
33- ========================================
32+ ldog Stack
33+ ==========
34+
35+ Laravel, Doctrine ORM, and GraphQL
36+ ----------------------------------
3437
3538This is a template application for building GraphQL applications in
36- Laravel with Doctrine ORM. **Known as the " ldog" stack .**
39+ Laravel with Doctrine ORM. **Known as the ldog Stack .**
3740
38- Source code available at https://github.com/api-skeletons/ldog
41+ To create a new project run
42+ \`\`\`
43+ composer create-project api-skeletons/ldog
44+ \`\`\`
3945
40- You may try it out with [graphiql](https://ldog.apiskeletons.dev/graphiql)
41- or POST to this server's GraphQL endpoint at https://ldog.apisketons.dev
46+ Source code available at https://github.com/api-skeletons/ldog
4247
43- Brought to you by [API Skeletons](mailto:contact@apiskeletons.com)
48+ This site is an exact copy of the ldog project. It includes an example
49+ Doctrine ORM schema and database served as GraphQL.
4450
51+ You may explore the GraphQL with [graphiql](https://ldog.apiskeletons.dev/graphiql)
52+ or POST to this server's GraphQL endpoint at https://ldog.apisketons.dev
4553
46- `
47- } ,
48- {
49- title : 'Install' ,
50- content : `
51- Install
52- =======
54+ ---
5355
54- To create a new project run
55- \`\`\`
56- composer create-project api-skeletons/ldog
57- \`\`\`
56+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
57+ * https://github.com/api-skeletons/ldog
5858 `
5959 } ,
6060 {
@@ -63,13 +63,18 @@ composer create-project api-skeletons/ldog
6363Getting Started
6464===============
6565
66- * Copy \`.env.example\` to \`.env\`
66+ * Copy \`.env.example\` or \`.env.dev\` to \`.env\`
6767* Run \`docker-compose up -d\`
6868* Connect to the docker instance by running \`docker ps\` to get the instance id,
6969 then \`docker exec -it {instanceId} bash\`
7070* Run \`composer install\`
7171* Create the database with \`php artisan doctrine:schema:create\`
7272* Generate the GraphQL documentation with \`magidoc generate\`
73+
74+ ---
75+
76+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
77+ * https://github.com/api-skeletons/ldog
7378 `
7479 } ,
7580 {
@@ -90,6 +95,11 @@ This is the ERD for the entities used in developing the stack.
9095 title="ERD"
9196 alt="ERD"
9297/>
98+
99+ ---
100+
101+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
102+ * https://github.com/api-skeletons/ldog
93103 `
94104 } ,
95105 {
@@ -102,6 +112,11 @@ GraphQL documentation is created with \`magidoc\`. Inside the container and fro
102112\`/var/www\`, run \`magidoc generate\` to create the documentation.
103113
104114Configuration is done via the \`~/magidoc.mjs\` file.
115+
116+ ---
117+
118+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
119+ * https://github.com/api-skeletons/ldog
105120 `
106121 } ,
107122 {
@@ -116,6 +131,11 @@ To ensure code quality, run \`composer test\` to run the following:
116131* [Doctrine Coding Standard](https://www.doctrine-project.org/projects/doctrine-coding-standard/en/11.0/reference/index.html)
117132* [Psalm](https://psalm.dev/docs/)
118133* [PHPUnit](https://docs.phpunit.de/en/10.5/)
134+
135+ ---
136+
137+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
138+ * https://github.com/api-skeletons/ldog
119139 `
120140 } ,
121141 {
@@ -132,6 +152,11 @@ Help Resources
132152* GraphQL Type Driver for Doctrine ORM - https://doctrine-orm-graphql.apiskeletons.dev/en/latest/
133153* Skipper - https://www.skipper18.com/help/
134154* magidoc - https://magidoc.js.org/introduction/welcome
155+
156+ ---
157+
158+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
159+ * https://github.com/api-skeletons/ldog
135160 `
136161 } ,
137162 {
@@ -201,6 +226,11 @@ query {
201226 }
202227}
203228\`\`\`
229+
230+ ---
231+
232+ A project of [API Skeletons](mailto:contact@apiskeletons.com)
233+ * https://github.com/api-skeletons/ldog
204234 `
205235 }
206236 ]
0 commit comments