Lingara Lingara Documentación Guías API Bibliotecas Apps Crear Aplicación web
Idioma: Español

Crear apps de Lingara

Esta página está traducida del inglés. Si ambas difieren, la página en inglés es la correcta. Leer la página en inglés

Una app de Lingara es un servidor que gestionas tú. Cuando un estudiante ha instalado tu app, Lingara envía a tu servidor una solicitud firmada, tu servidor responde con una tarjeta y Lingara dibuja esa tarjeta con su propio estilo. Tu código nunca se ejecuta en el dispositivo del estudiante y nunca ve lo que Lingara guarda allí.

Para Lingara, una app es un cliente OAuth con un manifiesto. El cliente le da a tu app su identidad. El manifiesto indica dónde puede aparecer su tarjeta, qué pide ver y adónde envía Lingara sus solicitudes.

Dónde aparece una tarjeta

Tu manifiesto nombra los espacios que tu tarjeta puede ocupar. Hay dos:

  • plans.empty_detail: el panel de detalle de la pantalla de planes de lección, mientras no hay ningún plan seleccionado. Se dibuja en la web, Android e iOS siempre que la pantalla sea lo bastante ancha para mostrar dos paneles.
  • home.side: la columna lateral de la página de inicio en la web.

Donde no se dibuja ninguno de los dos espacios, el estudiante abre tu app a pantalla completa desde Apps: en la consola en la web, y en Ajustes en Android e iOS. Cada espacio muestra una sola app a la vez. Cuando un estudiante ha instalado varias apps para el mismo espacio, elige cuál se muestra.

Quién puede instalar una app

Hoy una app solo puede instalarla su propietario, en su propia cuenta. Las instalaciones por parte de cualquier otra persona aún no están disponibles.

Qué necesitas

  • Un cliente OAuth, que creas en la consola.
  • Un servidor que responda a las solicitudes de Lingara por HTTPS.
  • Uno de los kits de app de abajo. Un kit comprueba la firma de cada solicitud, mantiene tu tarjeta dentro de los límites de Lingara antes de que la envíes y escribe la respuesta.

El inicio rápido recorre todo el camino, desde un cliente nuevo hasta una tarjeta en tu propia cuenta.

Instalar un kit

Elige tu lenguaje abajo.

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

Crear una app

  • Inicio rápido

    De un cliente OAuth nuevo a la tarjeta de tu app en tu propia cuenta.

  • Tarjetas

    Los ocho elementos de los que se compone una tarjeta, los límites que aplica Lingara y lo que ve un estudiante cuando una tarjeta falla.

  • Contexto y consentimiento

    Qué puede saber tu app sobre un estudiante, campo por campo, y cómo lo acepta el estudiante.

  • La nota para el tutor

    Una línea que tu app puede ofrecer al tutor de Lingara, y las reglas por las que pasa.