Skip to content
This repository has been archived by the owner on Jul 5, 2019. It is now read-only.

Update readme to add details about GITHUB_TOKEN #22

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme to add details about GITHUB_TOKEN #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<insert token here> 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
Expand Down