BenRoe/awesome-mechanical-keyboard
1
1
Fork 0
mirror of https://github.com/BenRoe/awesome-mechanical-keyboard.git synced 2024-11-28 23:42:12 +03:00
Code Issues Projects Releases Wiki Activity

build: add section "how to creating local development environment" (#115)

Browse Source
This commit is contained in:
Mateusz Ż 2021-11-01 17:41:21 +01:00 committed by GitHub
parent a7be3c5564
commit a44ed7685d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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/)