zoterobib

Babador Zotero

Visão geral

Este repositório contém código para Zotero Bib, incluindo componentes React, cliente de tradução, folhas de estilo e site de ponto de entrada.

Pré-requisitos

1. Nó JS com npm
2. Ferramentas básicas de linha de comando, incluindo rsync
3. Servidor de tradução existente
4. Servidor bib existente
5. Repositório de estilos existentes

Versão de Desenvolvimento Local

Obtendo a biblioteca

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

2. cd zoterobib

3. npm install

4. npm start

Isso servirá como demonstração em http://127.0.0.1:8001.

Talvez seja necessário fornecer opções de configuração (veja abaixo) para que o armazenamento e a tradução funcionem.

Por padrão, os proxies do servidor de desenvolvimento traduzem as solicitações do servidor para localhost:1969 . Se o seu servidor estiver localizado em outro lugar, você precisará fornecer o URL, por exemplo, a última etapa acima seria assim:

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

Isso fará proxy das solicitações do navegador para o servidor de tradução especificado.

Usando na produção

Para obter arquivos prontos para produção, use o seguinte comando npm:

npm run build

Configuração

É possível fornecer parâmetros de configuração para a construção (tanto em desenvolvimento quanto em produção) usando arquivos de configuração e/ou variáveis ​​de ambiente.

A maneira mais fácil é copiar config/default.json para config/local.json e colocar variáveis ​​​​lá (este arquivo é ignorado pelo git e não deve ser confirmado). Alternativamente, variáveis ​​de ambiente listadas em config/custom-environment-variables.json podem ser usadas. Para obter mais detalhes sobre como fornecer configurações, consulte config npm package.

Opções de configuração

As seguintes opções de configuração são aceitas:

storeURL Especifica o URL da API do servidor bib onde as bibliografias são armazenadas.

estilosURL Especifica o URL do site do repositório de estilos . Quando deixado em branco, o padrão será usado, que é https://www.zotero.org/styles-files/styles.json

translatePrefix Especifica um prefixo adicional para onde a solicitação do servidor de tradução deve ser enviada. Útil nos casos em que translateURL é deixado vazio para que seja possível direcionar solicitações para um endpoint específico onde quer que o zotero-bib esteja hospedado.

translateURL Especifica a URL para o servidor de tradução . Por padrão, localhost é considerado uma solicitação de proxy para o servidor de tradução.

apiAuthorityPart Especifica a parte de autoridade da URL para solicitações da API Zotero. O padrão é api.zotero.org .

Configuração do servidor de desenvolvimento

A execução de npm start verifica as seguintes variáveis ​​de ambiente:

TRANSLATE_URL Onde fazer proxy das solicitações de tradução, o padrão é http://localhost:1969. Por padrão, o ZoteroBib enviará solicitações de tradução para window.location.origin e o servidor de desenvolvimento deve ser configurado para fazer proxy dessas solicitações para um servidor de tradução.

PORT Em qual porta o servidor de desenvolvimento deve escutar, o padrão é 8001.

NO_HYDRATE Ao acessar uma bibliografia remota, o ZoteroBib pode hidratar a partir de HTML pré-renderizado para evitar um spinner durante o carregamento. Para fins de desenvolvimento, uma bibliografia codificada é armazenada em hydrate.hbs e é usada para atender qualquer solicitação que inclua um ID de bibliografia remota. Para desativar esse comportamento, defina NO_HYDRATE como 1 , que servirá index.hbs , o que significa que a bibliografia é sempre renderizada no lado do cliente com um botão giratório.