Skip to content
Snippets Groups Projects
Commit 55399bc9 authored by Pierre-Jean CHANCELLIER's avatar Pierre-Jean CHANCELLIER
Browse files

add documentation for graphQL schema

parent 2c10698b
No related branches found
No related tags found
No related merge requests found
......@@ -11,16 +11,25 @@ $ npm run analyze
$ git commit
$ git push
```
Then create a merge request.
### Add a new page
Copy/paste the file `./pages/template.vue` and rename it to create a new page. This template is extremly commented for beginners so you can create a query and display the response very easily even using i18n ! If you want to add your page in the menu, edit the `menus` variable in the `./layouts/default.vue` file.
Copy/paste the file `./pages/template.vue` and rename it to create a new page.
This template is extremly commented for beginners so you can create an apollo query and display the response very easily even using i18n !
If you want to add your page in the menu, edit the `menus` variable in the `./layouts/default.vue` file.
### ChartJS
There is an example to use component graph lazyly in `./pages/chartjs.vue`.
### GraphQL
The schema documentation is stored in [./doc/graphQLschema.txt](/doc/graphQLschema.txt).
All conf files for Apollo Graphql are stored in `./graphql`.
In `queries.js` you'll find all queries.
If you want to add a 2nd graphQL server, edit `./graphql/clients/endpoints.js` to put your URL and uncomment the line concerning the `apollo.clientConfigs.myotherclient` option in `nuxt.config.js`. I have not tested this functionnality.
### Special Directories
......@@ -95,6 +104,6 @@ $ npm run start
# generate static project
$ npm run generate
# generate introspection schema for graphql server
# update introspection schema for graphql server
$ npm run build-fragment
```
\ No newline at end of file
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment