GitHub-readme-stats解説
anuraghazra/github-readme-stats
ソフトウェアエンジニアの方にとって、anuraghazra/github-readme-stats がどのように役立つか、導入方法やサンプルコードを分かりやすく解説しますね。
このツールを一言で言うと、「GitHubのプロフィールやREADMEを、あなたの開発実績を視覚的にアピールする場に変える魔法のツール」 です。 ♂
ソフトウェアエンジニアにとって、GitHubはもはや履歴書のようなものです。しかし、ただリポジトリが並んでいるだけでは、パッと見て「この人、すごい！」とはなかなか伝わりませんよね。
このツールを使えば、以下のようなメリットがあります。
実績を視覚的にアピールできる
コミット数、スター数、プルリクエスト数などの活動データを、見栄えの良いグラフやカードとして自動生成し、表示できます。面接官や採用担当者が見たときに、あなたの活発な開発状況が一目でわかります。
メンテナンス不要で常に最新
サーバーレスで動くので、一度設定すれば、あなたのGitHubアクティビティが更新されるたびに、表示される統計情報も自動で最新の状態に更新されます。自分で手動で更新する必要はありません。
カスタマイズ性が高い
テーマ、色、表示する項目などを細かくカスタマイズできます。自分の好みに合わせて、おしゃれなプロフィールページを作ることができます。
簡単に導入できる
README.mdファイルに数行のコードを追加するだけで、すぐに使い始められます。複雑な設定やデプロイは不要です。
導入はとてもシンプルです。README.mdファイルに画像タグ <img> を追加するだけです。
あなたのGitHubユーザー名をURLの末尾に追加するだけです。
<img src="https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME" />
YOUR_USERNAME の部分をあなたのGitHubユーザー名に置き換えてください。例えば、ユーザー名が octocat であれば、以下のようになります。
<img src="https://github-readme-stats.vercel.app/api?username=octocat" />
このコードをREADME.mdに貼り付けるだけで、以下のようなデフォルトの統計情報カードが表示されます。
より詳細な情報や、デザインをカスタマイズしたい場合は、URLにクエリパラメータを追加します。
表示する統計情報を変更する (&show_icons=true)
アイコンを追加して見やすくします。
<img src="https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME&show_icons=true" />
テーマを変更する (&theme=THEME_NAME)
さまざまなプリセットテーマが用意されています。代表的なものとして dark, dracula, solarized などがあります。
<img src="https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME&show_icons=true&theme=dracula" />
特定の言語の統計カードを表示する (/api/top-langs/)
よく使っているプログラミング言語の統計を円グラフで表示できます。
<img src="https://github-readme-stats.vercel.app/api/top-langs/?username=YOUR_USERNAME&layout=compact" />
これらのカスタマイズオプションを組み合わせることで、あなたのプロフィールに合った、オリジナリティあふれる統計情報カードを作成できます。
詳しいカスタマイズオプションは、公式リポジトリのREADMEで確認してみてください。とても丁寧に解説されていますよ。
このツールの [serverless, dynamic] というタグについて、もう少し詳しく説明しますね。
これは、このツールがサーバーレス関数として動作していることを意味します。
ユーザーがURLにアクセスすると、GitHub APIを通じてあなたの最新の統計情報を取得し、その場で画像として生成して返します。この処理は、Vercelなどのサーバーレスプラットフォーム上で実行されます。
これにより、開発者は自分でサーバーを立てて運用する必要がありません。この手軽さが、多くのエンジニアに利用されている大きな理由の一つです。
