Skip to content

Commit

Permalink
build: add section "how to creating local development environment" (K…
Browse files Browse the repository at this point in the history
  • Loading branch information
mateossh authored Nov 1, 2021
1 parent a7be3c5 commit a44ed76
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,24 @@ Please use this [commit message conventions](https://www.conventionalcommits.org
The project uses [Gridsome](https://gridsome.org) as a Static Site Generator.
[![Netlify Status](https://api.netlify.com/api/v1/badges/06821f1d-3e33-4bd4-92b2-4e44f3583060/deploy-status)](https://app.netlify.com/sites/keebfolio/deploys)

#### Creating local development environment

##### Creating Github Auth Token

1. Go to `https://github.com/settings/tokens`
2. Click "Generate new token"
3. Set note and expiration, then click "Generate token"
4. Copy generated token, you will need it in another step

##### Installation and running local version

1. Create environment variables:
- `GITHUB_AUTH_TOKEN` with generated token as its value.
- `GITHUB_API_V4_URL` with value `https://api.github.com/graphql`
2. Clone repository
3. `npm install`
5. `npm run develop`

### License

[![CC4](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg)](http://creativecommons.org/licenses/by-nc-sa/4.0/)

0 comments on commit a44ed76

Please sign in to comment.