OpenFisca Shibuya （非公式）

概要

渋谷区の子育て支援制度のシミュレーターです。
世帯の属性を入力すると、利用可能な制度と手当額が表示されます。

環境構築方法

0. 前提

• GitHub にユーザー登録する
• Visual Studio Code をセットアップする

1. GitHub Codespaceを使用する方法

• （このリポジトリ を自分の GitHub アカウントに Fork する | 既に Fork してる場合は Fetch upstream する（必須））
• → Fork した自分のアカウントの側のリポジトリをブラウザで開き、緑色の「Code」ボタンをクリック
• → 「Create codespace on main」をクリック
• → 「Open this codespace in VS Code Desktop」をクリック
• → ダイアログが数回表示されるので全部 OK っぽい方をクリック
• → VSCode と GitHub を連携させるために認証が求められるので承認する
• → VSCode で GitHub Codespaces に無事に接続できたら、動作確認のために、ターミナルで make を実行

これだけで全員同じ環境で開発できるようになるはず。料金は 2022-07-02 現在、無料です。

このリポジトリを GitHub であなたのアカウントへ Fork して、 git clone する

Fork したあなたのリポジトリで、GitHub Codespaces を起動して、Visual Studio Code で開く

GitHub Codespaces で動作確認する

make

GitHub Codespaces で API サーバーとして動かす

make serve-local

• GET http://localhost:50000/spec
• GET http://localhost:50000/entities
• GET http://localhost:50000/variables
• GET http://localhost:50000/parameters

2. 自分のPCにDockerを使って開発環境を作る方法

• Docker Desktopをインストールして起動する。

  • Windowsの場合：WindowsでのDocker Desktop環境構築
  • Macの場合：MacでのDocker Desktop環境構築

• proj-inclusiveのOpenFisca Githubリポジトリを個人アカウントのリポジトリとしてフォークし、ローカル環境（自分のPC）にクローン（ダウンロード）する。
  フォーク・クローンの流れ .
  リポジトリのクローンはGithub desktop, Source treeなどのツールを使うのが簡単。

• 自分のPC上にクローンしたOpenfisca-Shibuyaのルートディレクトリで、WindowsならPowershell、MacならTerminalを開く。

• フロントエンド・バックエンドを一括で環境構築・起動 .

  # docker環境を構築・起動
  docker-compose up --build
  # 「Ctrlキー＋c」でdocker環境を停止
  

• バックエンドのみ環境構築・起動

  # docker環境を構築
  docker build ./ -t openfisca_japan
  # docker環境を起動
  docker run -it --rm -p 50000:50000 -v "$(pwd):/app" -u user openfisca_japan
  # $(pwd)はDockerfileが存在するディレクトリの絶対パスで置き換える必要があるかもしれない。
  # docker環境を終了
  exit
  
  

• フロントエンドのみ環境構築・起動

  # dashboardのディレクトリに移動
  cd dashboard
  # docker環境を構築
  docker build ./ -t openfisca_japan_dashboard
  # docker環境を起動
  docker run -it --rm -p 30000:30000 -v "$(pwd)/src:/app/src" -u user openfisca_japan_dashboard
  # docker環境を終了
  exit
  # 元のディレクトリに戻る
  cd ..
  

• フロントエンドを起動している場合は http://localhost:30000/ をブラウザに打ち込むとフォームが表示されます。

開発方法

1. バックエンド

• 事前準備
  Github CodeSpace或いは自分のPCでバックエンドのdocker環境に入る。

• テスト

  • 全てのテストを実行
    make test
  • 一部のテストを実行
    openfisca test --country-package openfisca_japan openfisca_japan/tests/実行したいテストファイル或いはディレクトリパス .
    テストファイル（~.yaml）は変更しても、上のコマンドで実行するときに反映される。

• 内部計算方法の修正
  openfisca_japan/variables/~.py等の計算方法を規定するファイルを修正する。
  以下のコマンドでビルドを行わないとテスト時に修正が反映されない。
  make build
  その後、上述のテストを行う。