dotnsf / githubapi

GitHub API

Overview

Sample for GitHub OAuth API.

Pre-requisites

• Create Github account

• Create a repository which is supposed to be handled by this application.

  • Create repository.

  • Make main branch name as "main".

  • Add, commit, and push at least one file into this main branch.

• If you want to make this repository to be used by another GitHub user, you need to add him/her as Collaborator in this repository.

Setup

• Sign-in to GitHub : https://github.com/

• Navigate from upper-right menu: Settings - Developer settings - OAuth Apps - New GitHub App

• Input App name, Homepage URL(http://localhost:8080 for example), Callback URL(http://localhost:8080/api/callback for example), and click Create GitHub App button.

• Copy client_id, (generated)client_secret, and callback_url, then paste them into settings.js.

• Edit repo_name in settings.js. This value is supposed to be a same name of repository which is created in above.

  • If your Github username is USER and repository name is REPO, then this value should be set as USER/REPO.

• Edit target_branch_name in settings.js, if needed. This value is a branch name of repository which is supposed to be created in initial setup and to be merged into.

How to run

• Install Node.js

  • https://nodejs.org/

• Git clone or Download this code:

  • $ git clone https://github.com/dotnsf/githubapi

  • $ cd githubapi

• Install dependant libraries:

  • $ npm install

• Run application:

  • $ node app

• Browse application with web browser:

  • http://localhost:8080/

GitHub OAuth API References

https://docs.github.com/en/developers/apps/building-oauth-apps

GitHub REST API References

https://docs.github.com/en/rest

References

https://qiita.com/ngs/items/34e51186a485c705ffdb

Licensing

This code islicensed under MIT.

Copyright

2021 K.Kimura @ Juge.Me all rights reserved.

githubapi's Issues

有効な SHA の管理方法

現在は（処理効率を考慮した結果として）セッション内で管理している。

セッションなしでも動くようにするべきか？　その場合は常に有効な SHA を取得してからメイン処理を行うよう変更する必要がある。

一方でセッションなしで動かすには SHA 以外の管理要素のことも考慮しないといけない（アクセストークンや GitHub ID など）。すべてに対応するのは非現実的でもある。今のままでも支障があるわけではない。

コードリファクタリング

リクエストオブジェクトをそのまま渡さずに処理できるよう関数化するべき

ファイルは個人ブランチ内に個人フォルダを最初に作成し、その中に格納するべき？

フォルダ分けしないと、マージした時に全てが同一フォルダ内に混ざって取り込まれてしまう。

フォルダを作るなら初期化時に個人 ID 名のフォルダを作って、.gitkeep ファイルを入れておくべき？
そして全てのファイル保存、一覧、削除の処理は同フォルダ内を対象に行うべき？

ログイン後、自分の Github ID を確認する方法

ブランチ一覧から、自分のブランチを選択したい場合に、どれを選べばよいかわからないため。

選択したファイルを個人ブランチから削除できるようにする

マージ専用ブランチの初期化

マージボタンは不要

ユーザーの操作でマージさせるのは不都合（main ブランチは README.md １つのままでよい、そうでないと他の人がマージした状態の main からブランチができてしまう）。

あるいはチェックアウト元専用のブランチを１つ作る？　作らせる必要があるのだとしたら面倒。

マージ先専用ブランチでもいいが・・・面倒なのは同じこと。

誰でも（ターゲットリポジトリに）ブランチを作ることができるか確認。作れない場合、設定で回避できるか？

バイナリファイル対応

日本語ファイル対応