Website made using React to show the ideas behind the API benchmark implementation portraying the provided README.
You must have a GitHub token set in your account in order to be able to contribute to this project. If you try to contribute without one, you won't be able to since the GitHub API will limit your access.
GitHub tokens are identifiers that you can set with specific rights (as in power of management) in your account. These tokens are required when contributing with open source so that you can be identified when making requests to the GitHub API.
- Click your profile picture on the GitHub website after logging in.
- In the menu that appears, click on
Settings. - Now, on the Settings screen, scroll down to the very bottom of the
page and click on
<> Developer settings. - Once you're there, click on
Personal access tokens. - Now, click on
Generate new token. - You can add a note to your token as a reminder of what it was created for.
- Set an expiration time for your token for extra safety, if you wish.
- Your token must have only two permissions:
public_reporead:org - Click on
Generate token. - Copy the token value that is generated.
- Create or find a file called
.env. - Inside that file, add or change the value of the variable
GITHUB_API_TOKENto the value of your token, like below. - Now you can install the dependencies by typing the installation command.
GITHUB_API_TOKEN=gh_api_token_with_read_org_and_read_reponpm ciIf you encounter any problems with this, try checking the Token tutorial right above this section.
# development watch mode
npm run dev
# production mode
npm run start