跳到内容

creativecommons/选择器

GitHub贡献者 GitHub赞助商 github 净现值法 最新版本、作用域npm包的Libraries.io依赖关系状态 净现值法 GitHub问题 GitHub回购明星 GitHub叉

选择器

Creative Commons许可证选择器旨在帮助人们了解CC许可证,并选择最适合他们需要的许可证。本报告中的新版本更加重视可用性以及六个CC许可的教育体验。

关于

包含新Creative Commons许可证选择器源代码的存储库。新的选择程序仍在测试阶段,可以找到测试版部署在这里

此网站是使用Vue.js公司(和vuecli)。

路线图

与新选择器发布相关的任务、问题和讨论将通过启动里程碑

行为准则

代码_ OF_ CONDUCT.md:

Creative Commons团队致力于培养一个受欢迎的社区。此项目和所有其他Creative Commons开放源码项目均受管理由我们的行为准则.请报告不合格行为conduct@creativecommons.org根据我们报告准则

贡献

请参见贡献.md

使用Docker

集装箱

这个docker-compose.yml公司文件定义了以下内容容器:

  1. chooser-web(选择-web)-简单NGINX容器服务文档/
  2. 选择器节点-节点14容器

需要Docker桌面

继续之前,请确保在本地计算机上安装了Docker。如果不是,请访问下载并安装Docker DesktopDocker的官员网站并遵循安装说明。

启动容器

容器可以通过以下方式启动:

码头工人组成

(请参见Docker Compose概述| Docker文档有关使用管理容器的详细信息码头工人作曲.)

初始设置

在选择节点容器可以有效使用之前NPM包来自包装-锁.json是必需的:

码头工人作曲执行官选择节点npm-ci

此步骤通常只需执行一次。

运行Node开发服务器

  1. 启动容器(见上文)
  2. 完成初始设置(见上文)
  3. 运行Node开发服务器
    码头工人作曲执行官选择节点npm运行服务

创建生产(独立)版本

  1. 启动容器(见上文)
  2. 完成初始设置(见上文)
  3. 运行Node开发服务器
    码头工人作曲执行官选择器节点npm运行构建
    • (这会自动从以下位置复制生成的文件距离/文档/)

选择器部署到GitHub页面。beta版的源文件部署包含在./文档/dir和是live。对的任何更改此目录的内容将自动部署,因此请小心修改此位置时。

创建独立(生产)生成

  1. 启动容器(见上文)
  2. 完成初始设置(见上文)
  3. 运行Node开发服务器
    码头工人作曲执行官选择节点npm运行生成
    • (这会自动从以下位置复制生成的文件距离/文档/)

选择器部署到GitHub页面。beta版的源文件部署包含在./文档/dir和are live。对的任何更改此目录的内容将自动部署,因此请小心修改此位置时。

对于嵌入式独立构建(无页眉或页脚),请运行:

码头工人作曲执行官chooser-node VUE_APP_CC_OUTPUT=嵌入式npm运行版本

(请不要将嵌入的生成提交到文档/)

创建web组件生成

  1. 启动容器(见上文)
  2. 完成初始设置(见上文)
  3. 运行Node开发服务器
    码头工人作曲执行官选择节点npm运行内置组件

这将在距离/名为的文件夹license-chooser.min.js许可证。它可以用来加载任何JS中的web组件项目。还有一个样本演示.html创建。

为了能够使用该文件,应该从集成器的web-app或在CDN上发布。以下代码可用于将其集成到其他应用程序中。

注意:Chooser组件取决于Vue 2.x,如下所示例子。

<script src=“https://cdn.jsdeliver.net/npm/vue@2.x.x“></script><script src=“https://unpkg.com/@creativecommons/chooser/dist/license-chooser.js“></script><license chooser><license chooser>

对于嵌入式web组件生成(无页眉或页脚),请运行:

码头工人作曲执行官chooser-node VUE_APP_CC_OUTPUT=嵌入式npm运行构建组件

在独立或嵌入式构建上执行单元测试

  1. 启动容器(见上文)
  2. 完成初始设置(见上文)
  3. 运行单元测试
    码头工人作曲执行官选择节点npm运行测试:单元

对web组件构建执行单元测试

  1. 启动容器(见上文)
  2. 完成初始设置(见上文)
  3. 创建web组件构建(请参见上文)
  4. 运行单元测试
    码头工人作曲执行官选择节点npm运行测试组件
    • 它使用dist/demo.html可以在其上运行测试。

执行柏树测试

  1. 启动容器(见上文)
  2. 运行柏树测试
    码头工人运行-it-v$PWD(美元):/e2e-w/e2e-e CYPRESS_baseUrl=http://host.docker.internal:8888柏树/包括:最新
    • (这将在首次运行时下载cypress/included图像)

CSS生成

Chooser使用PurgeCSS的PostCSS插件来缩小CSS捆绑包的大小。它会根据最终版本中的类自动删除未使用的CSS已构建捆绑包。动态组件或动态导入文件的某些样式也可以删除。如果您发现构建的站点缺少一些样式可以手动将必要的类或Regex表达式添加到安全主义者中的数组后处理配置.js文件。

嵌入式屏幕截图

该站点可以用两种不同的模式构建:嵌入的独立的嵌入的模式从应用程序中删除页眉和页脚外观如下:

以嵌入式模式构建的应用程序

嵌入嵌入的模式,设置环境变量VUE_APP_CC_OUTPUT=嵌入在构建之前在服务器上。如果VUE_APP_CC_输出未设置或设置为其他值,则应用程序将内置默认值独立的模式,具有自己的页眉和页脚。