learnosity/learnosity-demos

快速开始将 Learnosity API 集成到您的学习平台中。

dev-develop 2024-09-02 01:37 UTC

README

快速开始将 Learnosity API 集成到您的学习平台中。

概述

该存储库旨在允许用户快速查看和交互 Learnosity API 的核心功能。

每个页面都展示了对特定 Learnosity API 的基本集成,您可以从中利用和学习。

要求

  • PHP 7.4+
  • 您必须连接到互联网才能使用此网站

开始使用

以下展示了如何将此存储库中的代码配置为独立网站。

首先,使用以下命令获取代码

git clone https://github.com/Learnosity/learnosity-demos.git

注意:为了简化后续步骤,您需要 make 工具(通常在您平台的开发生态中可用)。如果此选项对您不可用,请参阅下一两个部分,它们展示了如何手动启动演示站点。

本项目附带的一个简单的 Makefile 允许您通过在刚创建的 learnosity-demos 目录中运行以下任一命令来启动一个或另一个模式。

make run-php  # See “Using PHP's native server” below to see what this does

然后您可以在浏览器中访问 https://:8080

请注意,您必须使用 localhost 作为域名(而不是 127.0.0.1)。任何端口都可以,但一些 API 的内部安全性限制了域名。因此,在您联系 Learnosity 并将特定域名列入白名单之前,访问被限制为 localhost

如果端口 8080 已被占用,您可以使用以下命令指定一个自定义端口

make run-php PORT=8000  # Using custom port 8000

然后您可以在浏览器中访问 https://:8000

使用 PHP 的本地服务器

您可以使用 PHP 的内置服务器快速启动。

git clone https://github.com/Learnosity/learnosity-demos.git
cd learnosity-demos
php -S localhost:8080 --docroot www

消费者

本包附带演示安全(消费者)凭据。如果您有自己的消费者详细信息(由 Learnosity 提供),您可以通过编辑 lrn_config.php 使用它们

文档

更多 API 文档可在 Learnosity 开发者文档 中找到

使用 Composer 管理 PHP 依赖项

虽然此演示项目附带依赖库(如 Learnosity SDK),以方便使用,但在生产项目中这样做不是推荐的做法。可以使用 composer 工具来安装和升级第三方库。

有关在您的平台设置 composer 的说明,请参阅 composer-getting-started。您可以在使用 git 克隆的 learnosity-demos 目录中尝试它,如前几节所述。

composer install # Reinstall dependencies as specified in the shipped composer.lock

composer update # Upgrade dependencies according to constraints in composer.json

注意,“开始使用”部分的基于 make 的说明为您处理以下内容。

为了简单起见,可以使用 get-composer.php 脚本获取 composer 的本地版本。它将被命名为 composer.phar,并且必须以 ./composer.phar 而不是 composer 的方式调用。

如果您使用的是 Mac OS X,您可以使用 Homebrew 来设置特定的 tap。

brew tap homebrew/php
brew install composer