Stylo

Stylo est un éditeur de textes pour articles scientifiques en sciences humaines et sociales.

L'environnement de travail de Stylo intègre une chaîne éditoriale complète basée sur pandoc et outillée des modules suivants :

• un éditeur de métadonnées
• un versionnage
• une gestion de la bibliographie
• différents formats exports : html5, xml (TEI, Erudit), pdf...
• l'annotation
• le partage de document

Stylo est disponible sur stylo.huma-num.fr

Plus d'informations sur la documentation.

Pré-requis

• Node.js v18+
• MongoDB
• (optionnel) Pandoc, pour le service d'export

Sous MacOS

brew tap mongodb/brew

brew install pandoc mongodb-community nvm
brew install --cask docker

nvm install v18 --default

Développement local

L'application se lance en combinant une base de données MongoDB, et des applications Node.js (v18+).

La première fois que vous installez le projet, lancez ces commandes :

cp stylo-example.env stylo.env
npm clean-install
npm --prefix front clean-install
npm --prefix export clean-install
npm --prefix graphql clean-install

Sans Docker

Avant un premier lancement, la variable SE_GRAPHQL_TOKEN doit être renseignée dans stylo.env à l'aide de la valeur produite par cette commande :

DOTENV_CONFIG_PATH=stylo.env NODE_OPTIONS="--require dotenv/config" npm run --prefix graphql generate-service-token --silent

Ensuite, ainsi que le reste du temps :

mongod --config /usr/local/etc/mongod.conf --fork
npm run dev

Avec Docker

Avant un premier lancement, la variable SE_GRAPHQL_TOKEN doit être renseignée dans stylo.env à l'aide de la valeur produite par cette commande :

docker compose run -ti --build --rm graphql-stylo npm run generate-service-token --silent

Ensuite, ainsi que le reste du temps :

docker compose up mongodb-stylo export-gateway pandoc-api
npm run dev

L'interface web de Stylo est alors disponible sur (localhost:3000).
L'API fonctionne sur localhost:3030 et le service d'export sur localhost:3060.

Installation

Pour installer une instance Stylo en tant que service à disposition d'utilisateur·ices, veuillez suivre la documentation dédiée dans le fichier HOWTO.md.

---