Lingara アプリの作り方

このページは英語から翻訳されています。内容に相違がある場合は、英語のページが正しい内容です。 英語のページを読む

Lingara アプリは、あなたが運用するサーバーです。学習者があなたのアプリをインストールすると、Lingara はあなたのサーバーに署名済みのリクエストを送り、サーバーはカードで応答し、Lingara はそのカードを独自のスタイルで描画します。あなたのコードが学習者のデバイス上で実行されることはなく、Lingara がそこに保存しているものを見ることもありません。

Lingara にとって、アプリとはマニフェストを持つ OAuth クライアントです。クライアントはアプリに身元（アイデンティティ）を与えます。マニフェストは、カードを表示できる場所、表示を求める情報、そして Lingara がリクエストを送る先を示します。

カードが表示される場所

マニフェストには、カードを表示できる場所（スロット）を指定します。スロットは 2 つあります：

• plans.empty_detail：レッスンプラン画面の詳細ペインで、プランが選択されていない間に使われます。Web、Android、iOS で、画面が 2 つのペインを表示できるほど広い場合に描画されます。
• home.side：Web のホームページのサイドカラムです。

どちらのスロットも描画されない場合、学習者は「アプリ」からあなたのアプリを全画面で開きます。Web ではコンソールから、Android と iOS では設定からです。各スロットには一度に 1 つのアプリが表示されます。学習者が同じスロットに複数のアプリをインストールしている場合は、どれを表示するかを学習者が選びます。

アプリをインストールできる人

現在、アプリをインストールできるのはその所有者だけで、所有者自身のアカウントに限られます。他の人によるインストールはまだ利用できません。

必要なもの

• コンソールで作成する OAuth クライアント。
• HTTPS で Lingara のリクエストに応答するサーバー。
• 下記のアプリキットのいずれか。キットは各リクエストの署名を検証し、送信前にカードを Lingara の制限内に収め、応答を書き出します。

クイックスタートでは、新しいクライアントの作成から自分のアカウントにカードが表示されるまでの全工程を説明します。

キットをインストールする

下で言語を選んでください。

npm install @lingara/apps@0.1.0-alpha.6

cargo add lingara-apps@0.1.0-alpha.6 --features axum
cargo add axum@0.8
cargo add tokio --features macros,net,rt-multi-thread

go get github.com/Spinning-Cat-Studios/lingara_app_framework_sdk/go@v0.1.0-alpha.6

<dependency>
  <groupId>com.getlingara</groupId>
  <artifactId>lingara-apps-java</artifactId>
  <version>0.1.0-alpha.6</version>
</dependency>

implementation("com.getlingara:lingara-apps-kotlin:0.1.0-alpha.6")

gem install lingara-apps -v 0.1.0-alpha.6

composer require spinningcatstudios/lingara-apps:0.1.0-alpha.6 spinningcatstudios/lingara:@alpha