How to update graphql schemas
The GraphQL schemas are defined in the schemas/*.graphql
files.
To update the schemas, you need to modify the schemas/*.graphql
files and then generate the schemas.
Generate the schemas for the frontend
To generate the schemas for the frontend, you need to run the following commands from the root of the project:
cp schemas/*.graphql junqo_front/lib/schemas/;
cd junqo_front;
dart run build_runner build
First, you copy the schemas/*.graphql
files to the junqo_front/lib/schemas/
directory.
Then, you go to the junqo_front
directory and run the dart run build_runner build
command to generate the corresponding .dart
files.
If you have created a new schema file, you need to add it to the build.yaml
file in the junqo_front
directory.
For more information, see the ferrygraphql documentation.
targets:
$default:
builders:
ferry_generator|graphql_builder:
enabled: true
options:
schemas:
- junqo_front|lib/schemas/schema.graphql
# Add your schema file here
ferry_generator|serializer_builder:
enabled: true
options:
schemas:
- junqo_front|lib/schemas/schema.graphql
# Add your schema file here
Generate the schemas for the backend
The schemas are automatically retrieved and generated from the schemas/*.graphql
files when the project is built.
If you want to manually generate the schemas, you can run the following command inside the junqo_back
directory:
npm run generate_types
This command will generate the junqo_back/src/graphql.schema.ts
containing the types for the backend. DO NOT modify this file manually, as it will be overwritten the next time the command is run. DO NOT commit this file to the repository, as it is generated automatically.