This is the repo for Strawberry GraphQL. If you want to edit the documentation head to the main repository.
This repo only contains the template and design of the website.
This shows the latest released version and not the master branch docs.
Shows the latest release from Strawberry Graphql Repo. These pages are rendered at build time and revalidated after 60 seconds. When a new release of Strawberry Graphql is done then the site should update Strawberry GraphQL site by itself. Not requiring a re-deployment.
Pull requests on Strawberry Graphql Repo with a label of ok-to-preview can be viewed. Theses are rendered on-demand and cached. They will be revalidated after 60 seconds.
Releases of Strawberry Graphql can be viewed. Theses are rendered on-demand and cached. But are not revalidated on the server unless a new deployment is done.
Make sure to have nodejs 14.16.0 (exact version shouldn't matter too much, you
can use asdf to install it, in case).
You also need a GitHub token, this is used to fetch the list of contributors for
the repo, you can create one with the following scopes
public_repo, read:packages, read:user, repo:status, following
this guide
or by clicking
this link
directly (notice it will ask you for a password).
The token needs to be stored in a .env file, like this:
GITHUB_TOKEN=123123123We are using npm to manage dependencies, so can install the dependencies by running
npm installTo run the website, you can use npm:
npm run devThis should start the server on http://localhost:3000
We generate the TypeScript typings for any GraphQL queries using.
Outputted to ./types/graphql.d.ts
To update them run.
npm run codegenAny new GraphQL query will need a comment before it to generate theses typings.
/* GraphQL */ `query GoesHere {}`;To run the website in debug mode:
npm run dev:inspectSee next.js docs on the different ways to connect to the debugger.
