Lingara Lingara Tài liệu Cẩm nang API Thư viện Ứng dụng Tạo Ứng dụng web
Ngôn ngữ: Tiếng Việt

Xây dựng ứng dụng Lingara

Trang này được dịch từ tiếng Anh. Nếu hai bản khác nhau, trang tiếng Anh là bản đúng. Đọc trang tiếng Anh

Ứng dụng Lingara là một máy chủ do bạn vận hành. Khi người học đã cài đặt ứng dụng của bạn, Lingara gửi đến máy chủ của bạn một yêu cầu đã ký, máy chủ của bạn trả lời bằng một thẻ, và Lingara vẽ thẻ đó theo phong cách riêng của mình. Mã của bạn không bao giờ chạy trên thiết bị của người học và không bao giờ thấy những gì Lingara lưu trữ ở đó.

Đối với Lingara, một ứng dụng là một ứng dụng khách OAuth có tệp kê khai. Ứng dụng khách mang lại danh tính cho ứng dụng của bạn. Tệp kê khai cho biết thẻ của nó có thể xuất hiện ở đâu, nó yêu cầu xem những gì, và Lingara gửi yêu cầu của nó đến đâu.

Nơi thẻ xuất hiện

Tệp kê khai của bạn nêu tên các vị trí mà thẻ của bạn có thể chiếm. Có hai vị trí:

  • plans.empty_detail: ngăn chi tiết của màn hình kế hoạch bài học, khi chưa có kế hoạch nào được chọn. Ngăn này được vẽ trên web, Android và iOS bất cứ khi nào màn hình đủ rộng để hiển thị hai ngăn.
  • home.side: cột bên của trang chủ trên web.

Ở những nơi không vẽ vị trí nào, người học mở ứng dụng của bạn ở chế độ toàn màn hình từ mục Ứng dụng: trong bảng điều khiển trên web, và trong Cài đặt trên Android và iOS. Mỗi vị trí hiển thị một ứng dụng tại một thời điểm. Khi người học đã cài đặt nhiều ứng dụng cho cùng một vị trí, họ chọn ứng dụng nào được hiển thị.

Ai có thể cài đặt ứng dụng

Hiện tại, chỉ chủ sở hữu mới có thể cài đặt ứng dụng, và chỉ trên tài khoản của chính họ. Việc cài đặt bởi bất kỳ ai khác chưa khả dụng.

Những gì bạn cần

  • Một ứng dụng khách OAuth, do bạn tạo trong bảng điều khiển.
  • Một máy chủ trả lời các yêu cầu của Lingara qua HTTPS.
  • Một trong các bộ công cụ ứng dụng bên dưới. Bộ công cụ kiểm tra chữ ký trên mỗi yêu cầu, giữ thẻ của bạn trong giới hạn của Lingara trước khi bạn gửi, và viết phản hồi.

Trang Bắt đầu nhanh hướng dẫn toàn bộ quy trình, từ một ứng dụng khách mới đến một thẻ trên tài khoản của chính bạn.

Cài đặt bộ công cụ

Chọn ngôn ngữ của bạn bên dưới.

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

Xây dựng một ứng dụng

  • Bắt đầu nhanh

    Từ một ứng dụng khách OAuth mới đến thẻ của ứng dụng trên tài khoản của chính bạn.

  • Thẻ

    Tám phần tử tạo nên một thẻ, các giới hạn mà Lingara áp dụng, và những gì người học thấy khi một thẻ gặp lỗi.

  • Ngữ cảnh và sự đồng ý

    Những gì ứng dụng của bạn có thể biết về người học, theo từng trường, và cách người học đồng ý với điều đó.

  • Ghi chú cho gia sư

    Một dòng mà ứng dụng của bạn có thể đưa cho gia sư của Lingara, và các quy tắc mà nó phải đi qua.