zoterobib

Зотеро нагрудник

Обзор

Этот репозиторий содержит код для Zotero Bib, включая компоненты React, клиент перевода, таблицы стилей и веб-сайт точки входа.

Предварительные условия

1. Node JS с npm
2. Базовые инструменты командной строки, включая rsync
3. Существующий сервер перевода
4. Существующий bib-сервер
5. Существующие стили-репозиторий

Локальная версия разработки

Получение библиотеки

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 Указывает URL-адрес API-интерфейса bib-сервера , где хранятся библиографии.

styleURL Указывает URL-адрес веб -сайта репозитория стилей . Если оставить пустым, будет использоваться значение по умолчанию: https://www.zotero.org/styles-files/styles.json.

TranslatePrefix Указывает дополнительный префикс для того, куда должен быть отправлен запрос сервера перевода. Полезно в тех случаях, когда translateURL оставлен пустым, чтобы можно было направлять запросы к определенной конечной точке, где бы ни размещался zotero-bib.

TranslateURL Указывает URL -адрес сервера перевода . По умолчанию предполагается, что localhost отправляет запрос на сервер перевода.

apiAuthorityPart Указывает часть полномочий URL-адреса для запросов API Zotero. По умолчанию — api.zotero.org .

Конфигурация сервера разработки

Запуск npm start проверяет следующие переменные среды:

TRANSLATE_URL Где проксировать запросы на перевод, по умолчанию — http://localhost:1969. По умолчанию ZoteroBib будет отправлять запросы на перевод в window.location.origin , и сервер разработки должен быть настроен на проксирование этих запросов на сервер перевода.

ПОРТ Порт, который должен прослушивать сервер разработки, по умолчанию — 8001.

NO_HYDRATE При доступе к удаленной библиографии ZoteroBib может использовать предварительно обработанный HTML, чтобы избежать появления счетчика при загрузке. В целях разработки жестко запрограммированная библиография хранится в hydrate.hbs и используется для обслуживания любого запроса, включающего идентификатор удаленной библиографии. Чтобы отключить это поведение, установите для NO_HYDRATE значение 1 , что вместо этого будет обслуживать index.hbs , что означает, что библиография всегда отображается на стороне клиента с помощью счетчика.