zoterobib

佐特罗围兜

概述

该存储库包含 Zotero Bib 的代码，包括 React 组件、翻译客户端、样式表和入口点网站。

先决条件

1. Node.js 与 npm
2. 基本命令行工具，包括 rsync
3. 现有翻译服务器
4. 现有号码布服务器
5. 现有样式-repo

本地开发版本

获取图书馆

1. git clone --recursive [email protected]:zotero/zoterobib.git

2. cd zoterobib

3. npm install

4. npm start

这将在 http://127.0.0.1:8001 上提供演示。

您可能需要提供配置选项（见下文）才能使存储和转换正常工作。

默认情况下，开发服务器将翻译服务器请求代理到 localhost:1969 。如果您的服务器位于其他地方，您需要提供 url，例如上面的最后一步将如下所示：

1. TRANSLATE_URL=http://localhost:1234 npm start

这会将浏览器的请求代理到指定的翻译服务器。

在生产中使用

要获取生产就绪文件，请使用以下 npm 命令：

npm run build

配置

可以使用配置文件和/或环境变量为构建（开发和生产）提供配置参数。

最简单的方法是将config/default.json复制到config/local.json并在那里放置变量（该文件被 git 忽略，不应提交）。或者可以使用config/custom-environment-variables.json中列出的环境变量。有关如何提供配置的更多详细信息，请参阅 config npm package。

配置选项

接受以下配置选项：

storeURL指定存储参考书目的bib-server api 的 url。

stylesURL指定styles-repo网站的 url。当留空时，将使用默认值，即 https://www.zotero.org/styles-files/styles.json

translatePrefix指定翻译服务器请求应发送到的位置的附加前缀。在translateURL留空的情况下很有用，这样就可以将请求定向到托管 zotero-bib 的特定端点。

translateURL指定翻译服务器的 URL。默认情况下，假定 localhost 将请求代理到翻译服务器。

apiAuthorityPart指定 Zotero API 请求的 URL 的权限部分。默认为api.zotero.org 。

开发服务器配置

运行npm start检查以下环境变量：

TRANSLATE_URL代理翻译请求的位置，默认为 http://localhost:1969。默认情况下，ZoteroBib 会将翻译请求发送到window.location.origin ，并且开发服务器应配置为将这些请求代理到翻译服务器。

PORT开发服务器应侦听哪个端口，默认为 8001。

NO_HYDRATE访问远程参考书目时，ZoteroBib 可以从预渲染的 HTML 中进行水合，以避免加载时出现旋转。出于开发目的，硬编码参考书目存储在hydrate.hbs中，并用于服务任何包含远程参考书目 ID 的请求。要禁用此行为，请将NO_HYDRATE设置为1 ，这将服务于index.hbs ，这意味着参考书目始终使用微调器在客户端呈现。