Lingara Lingara Documentação Guias API Bibliotecas Aplicações Criar Aplicação web
Idioma: Português

Criar aplicações Lingara

Esta página é uma tradução do inglês. Se as duas diferirem, a página em inglês é a correta. Ler a página em inglês

Uma aplicação Lingara é um servidor gerido por si. Quando um aprendente instala a sua aplicação, o Lingara envia ao seu servidor um pedido assinado, o seu servidor responde com um cartão e o Lingara desenha esse cartão no seu próprio estilo. O seu código nunca é executado no dispositivo do aprendente e nunca vê o que o Lingara lá guarda.

Para o Lingara, uma aplicação é um cliente OAuth com um manifest. O cliente dá à sua aplicação a sua identidade. O manifest indica onde o cartão pode aparecer, o que a aplicação pede para ver e para onde o Lingara envia os seus pedidos.

Onde aparece um cartão

O seu manifest indica os espaços que o seu cartão pode ocupar. Há dois:

  • plans.empty_detail: o painel de detalhe do ecrã de planos de lição, enquanto nenhum plano está selecionado. É desenhado na web, no Android e no iOS sempre que o ecrã é largo o suficiente para mostrar dois painéis.
  • home.side: a coluna lateral da página inicial na web.

Onde nenhum dos dois espaços é desenhado, o aprendente abre a sua aplicação em ecrã inteiro a partir de Aplicações: na consola, na web, e em Definições, no Android e no iOS. Cada espaço mostra uma aplicação de cada vez. Quando um aprendente instalou várias aplicações para o mesmo espaço, escolhe qual delas é mostrada.

Quem pode instalar uma aplicação

Atualmente, uma aplicação só pode ser instalada pelo seu proprietário, na sua própria conta. As instalações por qualquer outra pessoa ainda não estão disponíveis.

O que precisa

  • Um cliente OAuth, que cria na consola.
  • Um servidor que responda aos pedidos do Lingara por HTTPS.
  • Um dos kits de aplicação abaixo. Um kit verifica a assinatura de cada pedido, mantém o seu cartão dentro dos limites do Lingara antes de o enviar e escreve a resposta.

O início rápido percorre todo o caminho, desde um cliente novo até um cartão na sua própria conta.

Instalar um kit

Escolha a sua linguagem abaixo.

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

Criar uma aplicação

  • Início rápido

    De um cliente OAuth novo ao cartão da sua aplicação na sua própria conta.

  • Cartões

    Os oito elementos que compõem um cartão, os limites que o Lingara aplica e o que um aprendente vê quando um cartão falha.

  • Contexto e consentimento

    O que a sua aplicação pode saber sobre um aprendente, campo a campo, e como o aprendente o aceita.

  • A nota para o tutor

    Uma linha que a sua aplicação pode oferecer ao tutor do Lingara, e as regras por que passa.