bookreach-ui-ce

A Book-Curation Interface for School Librarians to Support Inquiry Learning. / 学校図書館による教材図書提供を支援するアプリケーション BookReach のユーザインタフェース（UI）．

https://github.com/bookreach/bookreach-ui-ce

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (5.5%) to scientific vocabulary

Keywords

elm elm-lang school-library user-interface

Last synced: 6 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: bookreach
License: mit
Language: JavaScript
Default Branch: main
Homepage: https://bookreach.github.io/bookreach-ui-ce/
Size: 1.9 MB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

elm elm-lang school-library user-interface

Created over 3 years ago · Last pushed over 3 years ago

Metadata Files

Readme Citation

BookReach UI (Community Edition)

English

学校図書館による教材図書提供を支援するアプリケーション BookReach のユーザインタフェース（UI）．

「授業で本を使いたいが、本校でどんな本が使えるかわからない。」

「先生に頼まれて図書リストを作っているが、授業内容がよくわからない。」

学校図書館を活用できる場面で、専門性の違いから生まれる難しさをサポートします．

BookReach-UIの画面イメージ

動作確認

https://bookreach.github.io/bookreach-ui-ce/ をブラウザで開いてください．

UI の操作方法

校種を選ぶ（高校には非対応）
教科書を選ぶ
支援予定の授業で扱う単元を選ぶ
推薦図書の候補を選ぶ
1. 書影をクリックすると，詳細が開くので，中身を確認する
2. 使えそうな本であれば「選択」ボタンをクリックする
ページ最下部にリストが自動作成される
必要に応じてリストを印刷したり，テキストファイルに書き出して Excel 等でさらに編集する

その他の機能など，詳細は下記論文をご覧ください．

開発

本リポジトリは下記論文で提案されたシステムの参考実装です．機能やコード構成など，まだまだ改善点がありますので，プルリクエスト大歓迎です！

開発を進めるためには，最低限下記のものをインストールする必要があります．

Elm は Web アプリケーション開発に適した素晴らしい関数型言語です．関数型と言ってもかなりわかりやすいシンプルな仕様になっていて，着実に自信を持って，それでいて楽しくコーディングできておすすめです．ご存じない方は公式サイトのチュートリアルなどご覧いただけたらと思います．

BookReach UI のコードは Elm で閉じていて，npm パッケージ等には依存していません．最近の（移り変わりが激しい）web 開発ツールに関する知識は不要です．

まず，プロジェクトに必要なツールをインストールします．

bash npm install # Elm関連の開発ツールをインストールします elm install # 本Elmコードが使用するElmパッケージをインストールします

./src 以下の Elm コードを変更するたびに，以下を実行します．

shell elm make src/Main.elm --debug --output=main.js # ElmコードをJSにコンパイルします

./index.html を開いていただくと，動作するアプリが表示されると思います．画面右下の Elm ロゴマークをクリックすると，便利な Elm デバッガーが立ち上がり，ステップごとの Elm モデル更新の様子がわかります（Elm の公式機能です！）．プロダクション環境にデプロイするときは，コンパイルオプションの --debug を外します．

elm-live という開発用 web サーバを使うと，上記のコンパイルとアプリのリロードをファイル変更に合わせて自動で実施してくれて便利です． npm パッケージに指定してあるので，上記手順を踏んでいればそのまま使えます．

bash npx elm-live src/Main.elm --start-page=index.html -- --output=main.js --debug

Misc. info

Bulma CSS を UI ブロックに使用しています． ./index.html で CDN から直接読み込んでいます (npm パッケージとして取り込んではいません)
図書データベースの API は json-server の仕様に準拠していることを前提としています．
- Glitch 上のサンプル API は少数の図書データをサンプルとして返戻しますが，著作権の問題でいくつかのフィールドについてランダム値を挿入しています．図書や教科書などに関するこれらデータの正しさは全く保証しないことをご承知おきください．
- サンプル API は Glitch の無料枠で運用しており，起動に数秒かかります
- ご自身で図書データベースを作成し，json-server で読み込んでローカル開発できます
- 図書データベースの仕様・要件は ./src/BookDB.elm から読み取っていただけると思います
個人的には，VSCode に Elm extension をインストールして開発しています
Safari と Brave ブラウザで動作確認していますが，厳密なテストは実施していません

Citations

このソフトウェアを利用した際は下記論文の引用をお願いします．

bibtex @ARTICLE{Yada2020, title = "学校図書館による教材提供を支援する図書選定システムの提案とユーザインタフェースの予備的評価", author = "矢田, 竣太郎 and 浅石, 卓真 and 宮田, 玲", journal = "日本図書館情報学会研究大会発表論文集", publisher = "日本図書館情報学会", volume = 68, pages = "9--12", year = 2020 }

./CITATION.cff や ./CITATIONS.bib もご覧ください．英語版や雑誌論文の書誌情報もあります．

ライセンス

MIT (./LICENCE)

開発者

矢田竣太郎

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Yada"
    given-names: "Shuntaro"
    orcid: "https://orcid.org/0000-0002-6209-1054"
title: "BookReach-UI Community Edition"
version: 1.0.0
date-released: 2022-07-31
url: "https://github.com/bookreach/bookreach-ui-ce"
preferred-citation:
  type: conference-paper
  title: "BookReach-UI: A Book-Curation Interface for School Librarians to Support Inquiry Learning"
  collection-title: "Towards Open and Trustworthy Digital Societies"
  collection-doi: 10.1007/978-3-030-91669-5
  editors:
    - family-names: "Ke"
      given-names: "Hao-Ren"
    - family-names: "Lee"
      given-names: "Chei Sian"
    - family-names: "Sugiyama"
      given-names: "Kazunari"
  authors:
    - family-names: "Yada"
      given-names: "Shuntaro"
      orcid: "https://orcid.org/0000-0002-6209-1054"
    - family-names: "Asaishi"
      given-names: "Takuma"
    - family-names: "Miyata"
      given-names: "Rei"
  conference:
    name: "Towards Open and Trustworthy Digital Societies"
    location: "Online"
    date-start: 2021-12-01
    date-end: 2021-12-03
  start: 96
  end: 104
  doi: 10.1007/978-3-030-91669-5_8
  year: 2021

GitHub Events

Total

Last Year

Committers

Last synced: over 1 year ago

All Time

Total Commits: 5
Total Committers: 1
Avg Commits per committer: 5.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Shuntaro Yada	c**t@s**m	5

Committer Domains (Top 20 + Academic)

shuntaroy.com: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies

package-lock.json npm

332 dependencies

package.json npm

elm-live ^4.0.2 development
json-server ^0.17.0 development
elm-format ^0.8.5
elm-test ^0.19.1-revision7

bookreach-ui-ce

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.ja.md

BookReach UI (Community Edition)

動作確認

UI の操作方法

開発

Misc. info

Citations

ライセンス

開発者

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies