Créer des applications Lingara
Cette page est traduite de l'anglais. En cas de différence, la page anglaise fait foi. Lire la page en anglais
Une application Lingara est un serveur que vous exploitez. Lorsqu’un apprenant a installé votre application, Lingara envoie à votre serveur une requête signée, votre serveur répond avec une carte, et Lingara dessine cette carte dans son propre style. Votre code ne s’exécute jamais sur l’appareil de l’apprenant et ne voit jamais ce que Lingara y stocke.
Pour Lingara, une application est un client OAuth doté d’un manifeste. Le client donne son identité à votre application. Le manifeste indique où sa carte peut apparaître, ce qu’elle demande à voir et où Lingara envoie ses requêtes.
Où une carte apparaît
Votre manifeste nomme les emplacements que votre carte peut occuper. Il y en a deux :
plans.empty_detail: le volet de détail de l’écran des plans de cours, tant qu’aucun plan n’est sélectionné. Il est dessiné sur le web, Android et iOS chaque fois que l’écran est assez large pour afficher deux volets.home.side: la colonne latérale de la page d’accueil sur le web.
Là où aucun de ces emplacements n’est dessiné, l’apprenant ouvre votre application en plein écran depuis Applications : dans la console sur le web, et dans Paramètres sur Android et iOS. Chaque emplacement affiche une seule application à la fois. Lorsqu’un apprenant a installé plusieurs applications pour le même emplacement, il choisit celle qui y est affichée.
Qui peut installer une application
Aujourd’hui, une application ne peut être installée que par son propriétaire, sur son propre compte. L’installation par d’autres personnes n’est pas encore disponible.
Ce dont vous avez besoin
- Un client OAuth, que vous créez dans la console.
- Un serveur qui répond aux requêtes de Lingara en HTTPS.
- L’un des kits d’application ci-dessous. Un kit vérifie la signature de chaque requête, maintient votre carte dans les limites de Lingara avant que vous ne l’envoyiez, et écrit la réponse.
Le démarrage rapide parcourt tout le chemin, d’un nouveau client jusqu’à une carte sur votre propre compte.
Installer un kit
Choisissez votre langage ci-dessous.
TypeScript
npm install @lingara/apps@0.1.0-alpha.6Rust
cargo add lingara-apps@0.1.0-alpha.6 --features axum
cargo add axum@0.8
cargo add tokio --features macros,net,rt-multi-threadGo
go get github.com/Spinning-Cat-Studios/lingara_app_framework_sdk/go@v0.1.0-alpha.6Java
<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.6PHP
composer require spinningcatstudios/lingara-apps:0.1.0-alpha.6 spinningcatstudios/lingara:@alphaCréer une application
- Démarrage rapide
D'un nouveau client OAuth à la carte de votre application sur votre propre compte.
- Cartes
Les huit éléments qui composent une carte, les limites qu'applique Lingara et ce que voit un apprenant quand une carte échoue.
- Contexte et consentement
Ce que votre application peut apprendre sur un apprenant, champ par champ, et comment l'apprenant y consent.
- La note au tuteur
Une ligne que votre application peut proposer au tuteur de Lingara, et les règles par lesquelles elle passe.