🧰 PROMIDAS

ダークモード

PROMIDAS ​

PROMIDASのドキュメントへようこそ。 あなたの目的や習熟度に合わせて、最適なガイドを選んでください。

🧰 PROMIDAS とは ​

ProtoPediaのデータを「もっと手軽に」「もっと高速に」扱うためのツールセットです。

APIから取得したデータをメモリ上に保存(キャッシュ)することで、以下のようなメリットを提供します：

  • 🧩 扱いやすい: 複雑なAPI通信やキャッシュ管理を意識せず、直感的なコードで開発できます。
  • ⚡ 効率的なAPI利用: 無駄なリクエストを削減し、APIサーバーへの負荷を軽減します。
  • 🚀 高速アクセス: 一度取得したデータはメモリから即座に検索できます。

データ分析スクリプトから本格的なWebアプリケーションまで、幅広く活用できます。

🗺️ 目的別ガイド ​

🔰 初めての方・APIを試してみたい ​

まずはここから始めましょう。セキュリティの基本と導入手順を解説します。

  1. 超初心者向けクイックスタート
    • Node.jsの知識がゼロでも安心。インストールから実行までを最短で行うためのガイドです。
  2. ユースケース (Use Cases)
    • ⚠️ 最重要: 「どこで実行するか」によるセキュリティリスクの違いを理解します。
  3. Getting Started
    • インストール、トークン取得、そして最初のコードを実行するまでのステップバイステップガイドです。
  4. インストールとアップデート
    • インストール、アップデート、バージョン確認の詳細ガイドです。

🧪 データを分析したい・ツールを作りたい ​

ローカル環境(自分のPC)で安全にデータを活用するためのガイドです。

  1. ローカル実行向けユースケース
    • データ分析、静的サイト生成、個人用ツール開発などの実践ガイド。
  2. Cookbook (逆引きレシピ集)
    • 「特定のタグを検索したい」「CSV出力したい」「ランキングを作りたい」など、コピー&ペーストで使えるコード集。

💻 Webアプリを作りたい・サーバーで動かしたい ​

上級者向け。セキュリティとアーキテクチャの深い理解が必要です。

  1. サーバー実行向けユースケース
    • Webアプリケーション開発のためのリソースマップ。高度なカスタマイズやセキュリティ設計について。
  2. モジュール別リファレンス
    • 各コンポーネントの詳細設計書へのリンクです。

📚 ドキュメント一覧 ​

入門・ガイド ​

実践レシピ ​

🧩 主な機能 ​

PROMIDASの主要な機能についての解説です。

🔧 モジュール別リファレンス (高度な内容) ​

PROMIDASの内部構造や高度なカスタマイズを行いたい開発者向けの詳細資料です。各ディレクトリ内のドキュメントへリンクしています。

Repository (統合モジュール) ​

最も一般的な利用形態である Repository の詳細です。

Fetcher (APIクライアント) ​

API通信部分のカスタマイズ(リトライ制御、モックなど)を行いたい場合。

Store (In-memoryストレージ) ​

キャッシュの挙動やデータ保持の仕組みを深く理解したい場合。

Logger (ロギング) ​

ログ出力先を変更したり、独自のロガーを組み込みたい場合。

Utils (ユーティリティ) ​

日付変換や型定義などのヘルパー関数について。

🛠️ プロジェクト情報 ​

🛡️ セキュリティ ​

🔍 深掘りPROMIDAS ​

貢献・開発 ​

🔗 リンク ​

📄 ライセンス ​

MIT License - See LICENSE