diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f9ce384 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# 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. + +``` +GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +``` + +Run local server. + +``` +deno run --allow-net --allow-read --allow-env debug.ts +``` + +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. + +``` +deno lint --unstable +``` \ No newline at end of file diff --git a/README.md b/README.md index e0d1ad2..dbaccd4 100644 --- a/README.md +++ b/README.md @@ -484,40 +484,4 @@ https://github-profile-trophy.vercel.app/?username=ryo-ma&no-frame=true # 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. - -``` -GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -``` - -Run local server. - -``` -deno run --allow-net --allow-read --allow-env debug.ts -``` - -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. - -``` -deno lint --unstable -``` +Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more details. \ No newline at end of file