Skip to content

README.ja.md

Latest commit

 

History

History
153 lines (101 loc) · 6.12 KB

README.ja.md

File metadata and controls

153 lines (101 loc) · 6.12 KB

⚠️ 翻訳に関する注意: このドキュメントはAIによって翻訳されました。誤りを見つけた場合は、お知らせください。ありがとうございます！

このプロジェクトは star-history/star-history からフォークされ、改良されました。元のプロジェクトにコードをマージしません。 本プロジェクトはチャートの実装を更新し、MongoDB を導入してデータをキャッシュします。これにより GitHub API の呼び出し回数を減らし、パフォーマンスを改善します。 ダークテーマを追加しました。

✨ gitdata analysis ✨

gitdata.xuanhun520.com、GitHubリポジトリに不足しているデータ統計と可視化機能を提供します。スター履歴チャート機能など。

Star History Chart

👆 これは、次のHTMLコードで作成された**ライブ**チャートです：👇

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date&theme=dark" />
  <source media="(prefers-color-scheme: light)" srcset="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date" />
  <img style="width: 800px; height: 533px;" alt="Star History Chart" src="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date" />
</picture>

✨ 機能

  • VChartをベースにしています。
  • 詳細データの表示をサポート
  • ワンクリックで高品質なチャート画像を生成;
  • 日付またはタイムラインに基づいた複数のチャート表示モードをサポート;
  • GitHub readmeやその他のウェブサイトにリアルタイムチャートを埋め込む（上部に埋め込んだ例のように）;
  • そして様々な便利な機能：
    • リポジトリの表示/非表示を切り替え;
    • リポジトリ名を入力するショートカット;
    • ソーシャルネットワークへのクイック共有;
    • 複数のリポジトリの入力をサポート;
    • ...さらに多くの機能が発見を待っています！

🌠 スクリーンショット

🏗 開発

Star-historyはモダンな技術スタックを使用して構築されています：Vue + Vite + TailwindCSS + @Visactor/VChart。

前提条件

依存関係のインストール

pnpm i

開発を開始

  • メインウェブサイトはgitdataのホームページで、VisActorオープンソースに関するほとんどの便利な機能とブログが含まれています。

    pnpm dev

    ウェブサイトは http://localhost:3000 で提供されます。

  • APIサーバーは**実験的な機能です。主にGitHub readmeに埋め込むことができるチャートSVGまたはPNG画像ファイルを生成**するために使用されます。

    APIサーバーの前提条件

    MongoDB Community Serverのインストール

    注意： パスワードを変更した後、.envファイルまたは環境変数の接続文字列を更新することを忘れないでください。

    環境変数の設定：

    MongoDBの設定は、実際の状況に応じて変更できます。

    # MongoDB接続文字列を設定
export MONGODB_URI="mongodb://[username]:[password]@localhost:27017/gitdata"
export MONGODB_DB_NAME="gitdata"
export MONGODB_COLLECTION_NAME="repo_cache"

    または、serverディレクトリに.envファイルを作成します：

    MONGODB_URI=mongodb://xuanhun:xuanhun@localhost:27017/gitdata
MONGODB_DB_NAME=gitdata
MONGODB_COLLECTION_NAME=repo_cache

    APIサーバーの起動

    cd server
pnpm i && pnpm dev

    APIサーバーは http://localhost:8080 で実行されます（HTTPSが有効な場合は https://localhost:8080）。

    トークン

    バックエンドサービスには、token.envファイルに配置された独自のGitHubトークンが必要です。

    HTTPSサポートを有効にする

    フロントエンドでHTTPSを有効にするには：

    1. SSL証明書を生成（開発用）：

      ./scripts/generate-ssl-cert.sh

      これにより、certs/ディレクトリに自己署名証明書が作成されます。

    2. フロントエンド（Vite）の場合：

      certs/ディレクトリに証明書ファイルが見つかった場合、Vite開発サーバーは自動的にHTTPSを使用します。または、カスタムパスを指定できます：

      export SSL_CERT_PATH=/path/to/cert.crt
export SSL_KEY_PATH=/path/to/key.key
pnpm dev

今後の計画

  • より多くの編集と注釈機能を追加
  • VChartコードの表示と編集、VChart公式エディターへのエクスポート
  • スター履歴のアニメーションビデオ（GIF）の生成
  • より多くのGitHubデータ統計と分析機能