Lingara Lingara Dokumentation Ratgeber API Bibliotheken Apps Erstellen Web-App
Sprache: Deutsch

Lingara-Apps entwickeln

Diese Seite ist aus dem Englischen übersetzt. Wenn die beiden voneinander abweichen, ist die englische Seite maßgeblich. Englische Seite lesen

Eine Lingara-App ist ein Server, den Sie betreiben. Wenn ein Lernender Ihre App installiert hat, sendet Lingara Ihrem Server eine signierte Anfrage, Ihr Server antwortet mit einer Karte, und Lingara zeichnet diese Karte in seinem eigenen Stil. Ihr Code läuft nie auf dem Gerät des Lernenden und sieht nie, was Lingara dort speichert.

Für Lingara ist eine App ein OAuth-Client mit einem Manifest. Der Client gibt Ihrer App ihre Identität. Das Manifest legt fest, wo ihre Karte erscheinen darf, was sie sehen möchte und wohin Lingara ihre Anfragen sendet.

Wo eine Karte erscheint

Ihr Manifest nennt die Plätze, die Ihre Karte füllen darf. Es gibt zwei:

  • plans.empty_detail: der Detailbereich des Lektionsplan-Bildschirms, solange kein Plan ausgewählt ist. Er wird im Web, unter Android und unter iOS gezeichnet, sobald der Bildschirm breit genug ist, um zwei Bereiche zu zeigen.
  • home.side: die Seitenspalte der Startseite im Web.

Wo keiner der beiden Plätze gezeichnet wird, öffnet der Lernende Ihre App im Vollbild über Apps: in der Konsole im Web und in den Einstellungen unter Android und iOS. Jeder Platz zeigt jeweils eine App. Hat ein Lernender mehrere Apps für denselben Platz installiert, wählt er, welche dort angezeigt wird.

Wer eine App installieren kann

Derzeit kann eine App nur von ihrem Besitzer installiert werden, auf seinem eigenen Konto. Installationen durch andere Personen sind noch nicht verfügbar.

Was Sie brauchen

  • Einen OAuth-Client, den Sie in der Konsole erstellen.
  • Einen Server, der Lingaras Anfragen über HTTPS beantwortet.
  • Eines der App-Kits unten. Ein Kit prüft die Signatur jeder Anfrage, hält Ihre Karte innerhalb der Grenzen von Lingara, bevor Sie sie senden, und schreibt die Antwort.

Der Schnellstart geht den ganzen Weg, von einem neuen Client bis zu einer Karte auf Ihrem eigenen Konto.

Ein Kit installieren

Wählen Sie unten Ihre Sprache.

TypeScript

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

Rust

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

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

Java

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

Kotlin

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

Ruby

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

PHP

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

Eine App entwickeln

  • Schnellstart

    Von einem neuen OAuth-Client bis zur Karte Ihrer App auf Ihrem eigenen Konto.

  • Karten

    Die acht Elemente, aus denen eine Karte besteht, die Grenzen, die Lingara anwendet, und was ein Lernender sieht, wenn eine Karte fehlschlägt.

  • Kontext und Einwilligung

    Was Ihre App über einen Lernenden erfahren kann, Feld für Feld, und wie der Lernende dem zustimmt.

  • Die Tutor-Notiz

    Eine Zeile, die Ihre App dem Tutor von Lingara mitgeben kann, und die Regeln, die sie durchläuft.