Strawberry GraphQL website
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.
How to setup the project
Make sure to have nodejs 12.18.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
, by following
this guide.
The token needs to be stored in a .env
file, like this:
GITHUB_TOKEN=123123123
Installing the dependencies
We are using npm to manage dependencies, so can install the dependencies by running
npm install
Configuration
If you want to test a documentation change, you can change the repo where we
fetch the documentation from by specifying DOCS_GIT_REMOTE
and
DOCS_GIT_BRANCH
in your .env
file. For example:
DOCS_GIT_REMOTE=https://github.com/strawberry-graphql/strawberry.git
DOCS_GIT_BRANCH=test-branch
Alternatively you can checkout the Strawberry
repo locally and specify it's location in your .env
file. For example:
DOCS_LOCAL_LOCATION=../strawberry/docs
Note: Make sure the path refers to the docs
subdirectory in the repo.
Running the website
To run the website, you can use npm:
npm run start
This should start the server on http://localhost:8000