Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 969 Bytes

DEVELOPMENT.md

File metadata and controls

21 lines (16 loc) · 969 Bytes
Raw

Development

This is a guid to develope the project. See README.md if you want to add your name.

Project setup

yarn install
yarn serve # Compiles and hot-reloads for development
yarn build # Compiles and minifies for production
yarn lint # Lints and fixes files

Building the nameDB.json

For Quick setup grab a copy from gh-pages branch and in put it inside public/.

The nameDB is a big json file which contains all user added json files into one. It also fetches github avatar url from GitHuB id. You will need a GitHub oAuth token to build nameDB.json. The script fetches avatar_url from GitHuB id and without oAuth GitHub limits 60 request per hours.

  1. Visit Personal Acess Tokens and create one.
  2. Create .env file.
  3. Add token in .env as GITHUB_TOKEN=<your token here>
  4. Run node .github/actions/buildDB.js