From 189f6bdaeea8fccfa896661590f8545f6f6de8e9 Mon Sep 17 00:00:00 2001 From: Matt Burman Date: Fri, 17 May 2019 15:45:36 +0100 Subject: [PATCH] Update readme to add details about GITHUB_TOKEN Let me know if I can help get the site back up in any way! --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 524184e..a72e1af 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,12 @@ Welcome to the source code for the HackSheffield website! We welcome pull reques 2. Clone this repository 3. `npm install` 4. Grab a GitHub personal access token (to power the team section): https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/ -5. `npm run start:dev` +5. `GITHUB_TOKEN= npm run start:dev` ### Minimum permissions required for GitHub token +The teams section is powered by the GitHub GraphQL API. To use the API, you need an access token with enough permissions. The website node app is configured to read the GITHUB_TOKEN environmental variable. Make sure this is set when deploying and/or running locally. + Make sure you have the following selected when generating your token in order to run the site: - repo