EDINETのXBRL情報で勘定項目を分析するためのツール(仮)

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

EDINETのXBRL情報で勘定項目を分析するためのツール フロントエンドプロジェクト

(back to top)

Built With

• Docker
• TypeScript
• node.js
• webpack.js
• React.js

(back to top)

Getting Started

Prerequisites

簡単に環境構築するために以下3つの導入をお願いします。

• Docker
• VSCode
• RemoteContainers(VSCode拡張)
  • DevContainer利用する場合に必要

Installation

1. リポジトリのクローン

   git clone https://github.com/Seibi0928/ResearchXBRL.Frontend.git

2. コンテナ環境構築

• Devcontainerを使う場合

  • VSCodeを開く

    code ./ResearchXBRL.Frontend

  • F1を押下しコマンドパレットを開く
  • Reopen in Containerと入力し選択

• DevContainerを使わない場合

cd ResearchXBRL.Frontend
docker-compose -f ./devcontainer/docker-compose.yml up

3. データのインポートを行う(こちら)

EDINETのデータインポート方法

• 付属のインポート用バッチを利用します
  • ホストマシン側で以下コマンドを実行してください
  • 以下コマンドでは直近一日分をインポートできます

docker exec aquire_financial_reports_batch dotnet /app/AquireFinancialReports.dll

• 任意で実行時引数を指定できます

  • --from

    • 取得する書類の提出日下限を指定します
    • 指定しない場合は24時間前の日時が指定されます
    • 5年以上前の日時を指定した場合エラーになります EDINETは直近5年のデータしか返さないため

  • --to

    • 取得する書類の提出日上限を指定します
    • 指定しない場合は現時刻が指定されます
    • 5年以上前の日時を指定した場合エラーになります EDINETは直近5年のデータしか返さないため

  • --maxParallelism

    • インポート処理の並列数を指定します
    • 指定しない場合は1が指定されます

• 引数を使用したコマンドの一例

docker exec aquire_financial_reports_batch dotnet /app/AquireFinancialReports.dll --from 2021-01-01 --to 2021-12-01 --maxParallelism 2

(back to top)

Usage

※ 環境構築が済み、報告書データのインポートが完了していることが前提

1. ブラウザで分析画面へアクセス
2. 企業名と会計項目名を選択する
3. 時系列グラフが表示される

(back to top)

Contributing

歓迎

1. プロジェクトをフォーク
2. featureブランチ作成 (git checkout -b feature/AmazingFeature)
3. 変更をコミット (git commit -m 'Add some AmazingFeature')
4. ブランチをプッシュ (git push origin feature/AmazingFeature)
5. developブランチへプルリク

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

[email protected]

(back to top)