From a44ed7685dde9144f99207ebf52a715984d26b76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20=C5=BB?= Date: Mon, 1 Nov 2021 17:41:21 +0100 Subject: [PATCH] build: add section "how to creating local development environment" (#115) --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 30c6b75..f7c4bda 100755 --- a/README.md +++ b/README.md @@ -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/)