github-profile-trophy-reiyu.../CONTRIBUTING.md
Alexandro Castro 495eba6a75
chore: types improvements (#226)
chore: types improvements

chore: types improvements
2023-09-30 14:49:18 +09:00

44 lines
851 B
Markdown

# Contribution Guide
## Environment
- Deno >= v1.9.2
- [Vercel](https://vercel.com/)
- GitHub API v4
## Local Run
Create `.env` file to project root directory, and write your GitHub token to the
`.env` file. Please select the authority of `repo` when creating token.
```properties
GITHUB_TOKEN1=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
GITHUB_TOKEN2=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
# if using GitHub Enterprise:
# (this env var defaults to https://api.github.com/graphql)
GITHUB_API=https://github.example.com/api/graphql
```
Run local server.
```sh
deno task start
```
Open localhost from your browser.
http://localhost:8080/?username=ryo-ma
## Editor config
Read the [.editorconfig](./.editorconfig)
## Run deno lint
If you want to contribute to my project, you should check the lint with the
following command.
```sh
deno lint --unstable
```