OASIS Map - ウェルビーイングを実現するための、地域の協調的幸福度の可視化プラットフォーム

本プロジェクトについて

基盤ソフトウェア「FIWARE (ファイウェア)」を用いて、地域の協調的幸福度を可視化するプラットフォーム

OASIS Mapの始め方クイックスタート

概要

docker composeで提供しております
docker compose 2.21.0, docker 24.0.7 をインストール済みの Ubuntu 22.04.3 上で動作確認しております
またインストールの中で curl を使用しております
対応ブラウザ
- Chrome
- Safari

インストール方法

git clone

git clone git@github.com:c-3lab/oasismap.git

作業ディレクトリに移動
```
cd oasismap
```
MongoDBとPostgreSQLのユーザー、パスワードおよび地図の初期パラメータ値(緯度、経度、ズーム値)、KeyCloakの設定を.envに設定
```
~/oasismap$ cp _env .env
~/oasismap$ vi .env
```
※以下の環境変数は後ほど設定
- KC_HOSTNAME_URL
- KC_HOSTNAME_ADMIN_URL
- KEYCLOAK_CLIENT_ISSUER
- GENERAL_USER_KEYCLOAK_CLIENT_SECRET
- ADMIN_KEYCLOAK_CLIENT_SECRET
ngrokのアカウントを登録する
https://ngrok.com/
手順に従いngrokをインストールする
https://ngrok.com/docs/getting-started/

ngrok起動

~/oasismap$ ngrok http 8080

Try the new Traffic Inspector dev preview: https://ngrok.com/r/ti                                   
                                                                                                    
Session Status                online                                                                
Account                       アカウント名 (Plan: Free)                                            
Version                       3.6.0                                                                 
Region                        Japan (jp)                                                            
Latency                       5ms                                                                   
Web Interface                 http://127.0.0.1:4040                                                 
Forwarding                    https://xxxx-xxx-xxx-x-xx.ngrok-free.app -> http://localhost:8080     
                                                                                                    
Connections                   ttl     opn     rt1     rt5     p50     p90                           
                              1224    0       0.00    0.01    0.06    6.29                          
                                                                                                    
HTTP Requests

Forwarding から https:// で始まるURLを取得する

環境変数 KC_HOSTNAME_URL KC_HOSTNAME_ADMIN_URL KEYCLOAK_CLIENT_ISSUER に上記のURLを設定する

KC_HOSTNAME_URL=https://xxxx-xxx-xxx-x-xx.ngrok-free.app
KC_HOSTNAME_ADMIN_URL=https://xxxx-xxx-xxx-x-xx.ngrok-free.app
KEYCLOAK_CLIENT_ISSUER=https://xxxx-xxx-xxx-x-xx.ngrok-free.app/realms/oasismap

Dockerコンテナを展開
```
~/oasismap$ docker compose up -d
```

位置情報の利用について

OASIS Mapでは現在の位置情報を利用します。
但し http で動作させた場合は実際の位置情報ではなく、仮の位置情報が使われます。
実際の位置情報を利用する場合は、Keycloakの他にOASIS Map本体も https で動作させる必要があります。
手順は現在位置情報を利用した動作確認手順を確認してください。

仮の位置情報で問題ない場合は本手順はスキップしてください。

Google Cloud 事前準備

Google Cloudに接続
プロジェクトを選択 から新しいプロジェクトを作成
認証情報を作成 を選択して OAuth クライアント ID を作成
アプリケーションの種類に ウェブアプリケーション を選択して作成
クライアントID、シークレットを keycloak/variables.json の GoogleClientID GoogleClientSecret に転記

Keycloak 自動設定

keycloakディレクトリに移動
```
cd keycloak
```
formatting-variables.sh を実行して都道府県名/市区町村名の情報を variables.json に設定
```
~/keycloak$ bash formatting-variables.sh cities.json
```

自動設定スクリプトで利用する環境変数を設定

~/keycloak$ export KEYCLOAK_ADMIN={.envで指定した管理者ユーザー名}
~/keycloak$ export KEYCLOAK_ADMIN_PASSWORD={.envで指定した管理者ユーザーのパスワード}

keycloakディレクトリのパスを取得
```
~/keycloak$ pwd
```

以下のコマンドを実行
※ 4で取得したkeycloakディレクトリのパスに書き換えて実行すること

~/keycloak$ docker run --network oasismap_backend-network --volume {keycloakディレクトリのパス}:/etc/newman/keycloak \
postman/newman:latest run --bail --environment /etc/newman/keycloak/variables.json \
--env-var "KeycloakAdminUser=$KEYCLOAK_ADMIN" \
--env-var "KeycloakAdminPassword=$KEYCLOAK_ADMIN_PASSWORD" \
/etc/newman/keycloak/postman-collection.json

環境変数の準備と追加

ブラウザから http://Dockerホスト名:8080でアクセスします。
「Administration Console」をクリック
環境変数 KEYCLOAK_ADMIN KEYCLOAK_ADMIN_PASSWORD に指定した認証情報でログイン

Google CloudにリダイレクトURIを設定

realm から oasismap を選択
左のメニューバーから Identity providers を選択
google をクリック
Redirect URI の値をコピーして控えておく
Google Cloudに接続
事前準備にて作成した認証情報を選択
承認済みのリダイレクトURI に控えておいた Redirect URI を転記して保存

利用者向けクライアントシークレットの設定

realm から oasismap を選択
左のメニューバーから client をクリック
general-user-client をクリック
Credentials をクリック
Client Secret の値を環境変数 GENERAL_USER_KEYCLOAK_CLIENT_SECRET に転記

自治体管理者向けクライアントシークレットの設定

realm に oasismap を選択
左のメニューバーから client をクリック
admin-client をクリック
Credentials をクリック
Client Secret の値を環境変数 ADMIN_KEYCLOAK_CLIENT_SECRET に転記

コンテナを再起動して環境変数を反映させる

~/oasismap$ docker compose up -d frontend

orionにサブスクリプション設定を行う

バックエンドのコンテナにはいる

docker compose -f docker-compose-dev.yml exec backend bash

以下コマンドを実行してorionにサブスクリプションの設定を行う

root@backend:/app/backend$ curl -iX POST \
  --url 'http://orion:1026/v2/subscriptions' \
  --header 'content-type: application/json' \
  --header 'Fiware-Service: Government' \
  --header 'Fiware-ServicePath: /Happiness' \
  --data '{
  "description": "Notice of entities change",
  "subject": {
    "entities": [
      {
        "idPattern": ".*",
        "type": "happiness"
      }
    ],
    "condition": {
      "attrs": []
    }
  },
  "notification": {
    "http": {
      "url": "http://cygnus:5055/notify"
    }
  }
}'

基本的な使い方

自治体管理者向け

自治体管理者アカウントの準備

ブラウザから http://Dockerホスト名:8080 でアクセスします
「Administration Console」をクリック
環境変数 KEYCLOAK_ADMIN KEYCLOAK_ADMIN_PASSWORD に指定した認証情報でログイン
realm から oasismap を選択
左のメニューバーから Users を選択
Add User を選択
Username,profile.attribute.nickname を入力して Create を選択
※ Username と profile.attribute.nickname は同じ値を入れてください
Credentials を選択して Set password からパスワードを入力してください
パスワード入力後, Temporary のチェックを外して Save
Save password から保存

自治体管理者機能の使い方

ブラウザから http://Dockerホスト名:3000/admin/login でアクセスします
自治体管理者用アカウントでログインします
右端のハンバーガーメニューの データエクスポート から幸福度情報をダウンロードできます

利用者向け

幸福度の入力

画面下の 幸福度の入力 をクリックします
任意の項目にチェックを入れて 幸福度を送信 をクリックします

利用者幸福度の表示

右端のハンバーガーメニューをクリックします
一覧から 利用者の幸福度 をクリックします
利用者の幸福度 が地図上とグラフに表示されます

全体幸福度の表示

右端のハンバーガーメニューをクリックします
一覧から 全体の幸福度 をクリックします
全体の幸福度 が地図上とグラフに表示されます

アプリケーション停止方法

コンテナを停止
```
~/oasismap$ docker compose down
```

利用バージョン

ライセンス

AGPL-3.0

Name		Name	Last commit message	Last commit date
Latest commit History 65 Commits
.husky		.husky
backend		backend
doc		doc
dummyBackend		dummyBackend
frontend		frontend
keycloak-extension		keycloak-extension
keycloak		keycloak
setup		setup
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
_env		_env
docker-compose-dev.yml		docker-compose-dev.yml
docker-compose.yml		docker-compose.yml

License

c-3lab/oasismap

Folders and files

Latest commit

History

Repository files navigation