gendou(temporary name)

send functions

Stack

• npm client is yarn
• Testing is ava
• Linting is eslint
• Basic lint rule set is eslint-plugin-functional
• Formatter is prettier
• Pre-install utility is ramda

Usage

Create a repository using this template; just runs following command.

yarn

DB セットアップ

テスト時、データを保存するためのデータベースをローカルに構築する。事前に docker desktop など、docker が稼働する環境の構築を完了しておくこと。

cd docker
docker-compose up -d

下記コマンドで DB に接続することができる

psql postgresql://testuser@localhost:5432/testdb
パスワード:testpassword

環境変数

設定するファイルは local.settings.json。下記の 4 つ以外はそのままで大丈夫。

DATABASE_URL:DBのURL
BASE_DATE_3_YEAR:検索基準日、「YYYY-MM-DD」形式で指定する。検索基準日と検索基準日-1年と検索基準日-2年と検索基準日-3年と検索期間となる
GITHUB_API_TOKEN:GitHubのGraphQLを実行するときに利用するトークン。公開情報しか取得しないので、何も権限を持たないPATで大丈夫
GITHUB_CLIENT_ID:GitHub OAuthのクライアントID
GITHUB_CLIENT_SECRETS:GitHub OAuthのクライアントシークレットID

Azure Functions 起動

下記コマンドで Azure Functions が稼働する。

npm start

テーブル定義の追加

prisma/schema.prisma にテーブル定義を記述して

npx prisma migrate dev --name init

を実行するとテーブル SQL が作成される

GitHub Actions で利用するので、docker/db/init 　以下に移動させておくこと

参考 https://www.prisma.io/docs/getting-started/setup-prisma/start-from-scratch-typescript-postgres

api interface

info

パラメータに指定した github id に該当するユーザの報酬情報を取得します。

URL:https://{domain}/v2/info/{github_id}
method:get
例）curl http://localhost:7071/v2/info/github-id1

パラメータ

github_id:GitHub のユーザ ID

レスポンス

reward:報酬額、整数のため、実際に付与される報酬額に 10*18 をかけた数字が帰ってくる
contributions:貢献数
github_id:github の id

infoByCode

パラメータに設定した github oauth code に該当するユーザの報酬情報を取得します。

URL:http://{domain}/v2/infoByCode
method:post
例）curl -X POST -d '{"code":"abcde......"}' http://localhost:7071/v2/infoByCode

パラメータ

code:GitHub OAuth 認証後に発行されるコード

レスポンス

reward:報酬額、整数のため、実際に付与される報酬額に 10*18 をかけた数字が帰ってくる
contributions:貢献数
github_id:github の id
access_token:ユーザの PAT

entry

パラメータに設定した PAT や sign を使ってエントリー情報を保存します。

URL:http://{domain}/v2/entry
method:post
例）curl -X POST -d '{"access_token":"gho_abcde....", "sign":"0x1234...."}' http://localhost:7071/v2/entry

パラメータ

access_token:ユーザの PAT
sign:ユーザのアドレスを github id を使って署名した文字列

レスポンス

github_id:github の id
address:エントリーとして登録されたアドレス

get-entry

パラメータに設定した PAT や sign を使ってエントリー情報を保存します。

URL:http://{domain}/v2/get_entry
method:post
例）curl -X POST -d '{"access_token":"gho_abcde...."}' http://localhost:7071/v2/get_entry

パラメータ

access_token:ユーザの PAT

レスポンス

id:エントリーID github_id:エントリーした人のgithub id address:エントリーした人のアドレス sign:エントリーした人のsign情報 reward:報酬額 contribution_count:貢献数 create_at:作成日 update_at:更新日