zoterobib

Bavoir Zotero

Aperçu

Ce dépôt contient du code pour Zotero Bib, y compris des composants React, un client de traduction, des feuilles de style et un site Web de point d'entrée.

Conditions préalables

1. Noeud JS avec npm
2. Outils de ligne de commande de base, notamment rsync
3. Serveur de traduction existant
4. Serveur Bib existant
5. Styles-repo existants

Version développement local

Obtenir la bibliothèque

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

2. cd zoterobib

3. npm install

4. npm start

Cela servira de démo sur http://127.0.0.1:8001.

Vous devrez peut-être fournir des options de configuration (voir ci-dessous) pour que le stockage et la traduction fonctionnent.

Par défaut, le serveur de développement transmet les requêtes du serveur de traduction à localhost:1969 . Si votre serveur est situé ailleurs, vous devez fournir l'URL, par exemple la dernière étape ci-dessus ressemblerait à ceci :

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

Cela transmettra les requêtes du navigateur au serveur de traduction spécifié.

Utilisation en production

Pour obtenir des fichiers prêts pour la production, utilisez la commande npm suivante :

npm run build

Configuration

Il est possible de fournir des paramètres de configuration pour la build (à la fois en développement et en production) à l'aide de fichiers de configuration et/ou de variables d'environnement.

Le moyen le plus simple est de copier config/default.json dans config/local.json et d'y placer des variables (ce fichier est ignoré par git et ne doit pas être validé). Alternativement, les variables d'environnement répertoriées dans config/custom-environment-variables.json peuvent être utilisées. Pour plus de détails sur la façon de fournir des configurations, consultez le package config npm.

Options de configuration

Les options de configuration suivantes sont acceptées :

storeURL Spécifie l'URL de l'API du serveur Bib où les bibliographies sont stockées.

stylesURL Spécifie l'URL du site Web styles-repo . Lorsqu'il est laissé vide, la valeur par défaut sera utilisée, à savoir https://www.zotero.org/styles-files/styles.json

translatePrefix Spécifie un préfixe supplémentaire pour l'endroit où la demande du serveur de traduction doit être envoyée. Utile dans les cas où translateURL est laissé vide afin qu'il soit possible de diriger les requêtes vers un point de terminaison spécifique là où zotero-bib est hébergé.

TranslateURL Spécifie l'URL du serveur de traduction . Par défaut, localhost est supposé envoyer une requête proxy au serveur de traduction.

apiAuthorityPart Spécifie la partie autorité de l'URL pour les requêtes API Zotero. La valeur par défaut est api.zotero.org .

Configuration du serveur de développement

L'exécution npm start vérifie les variables d'environnement suivantes :

TRANSLATE_URL Où envoyer par proxy les demandes de traduction, par défaut http://localhost:1969. Par défaut, ZoteroBib enverra les demandes de traduction à window.location.origin et le serveur de développement doit être configuré pour envoyer ces demandes par proxy à un serveur de traduction.

PORT Sur quel port le serveur de développement doit-il écouter, la valeur par défaut est 8001.

NO_HYDRATE Lors de l'accès à une bibliographie distante, ZoteroBib peut s'hydrater à partir du HTML pré-rendu pour éviter une double flèche lors du chargement. À des fins de développement, une bibliographie codée en dur est stockée dans hydrate.hbs et est utilisée pour répondre à toute demande incluant un identifiant de bibliographie distante. Pour désactiver ce comportement, définissez NO_HYDRATE sur 1 , qui servira à la place index.hbs , ce qui signifie que la bibliographie est toujours rendue côté client avec une double flèche.