Ovide [alpha]

an experimental writing and publishing application for materials-based composition

Ovide is an editor built with the Peritext ecosystem.

It is provided both as a web and desktop application.

Installation for use

You can test Ovide online or go the releases page in order to download Ovide desktop version for your Operating System.

Installation for development

As a prerequisite you will need git and nodejs softwares installed.

Then:

1. Get a google api key in google dev console -> https://console.developers.google.com then enable youtube api (for automatic metadata retrieval for video resources)
2. Get a maptiler key (for glossary geolocalization server) - https://cloud.maptiler.com/geocoding/
3. Open a terminal/bash and type the following lines :

git clone https://github.com/peritext/ovide
cd ovide
npm install
cp app/config/sample.json app/config/default.json

4. Fill app/config/default.json with your credentials.

Main dev scripts

# run in electron/dev mode with hot reloading
npm run dev:electron

# run in web/dev mode with hot reloading
npm run dev:web

# pack electron application for all platforms
npm run pack

# build web version for production
npm run build:web

# diagnose and fix js code style and inconsistencies
npm run lint:fix

[advanced users] Modifying ovide configuration

Ovide is designed to allow an easy forking and customization in order to change the types of resources, contextualizers and edition templates available in the app.

Everything about this happens in app/src/peritextConfig.render.js : just modify the JS object exposed by this module to require specific schemas or components that you would want to use instead of the default config.

Note: more doc may be written about ovide customization at some point in the future if the tool proves useful for an extended community.

Contributing to ovide

The source code of Ovide is published under free license AGPL-3.0.

This software is currently in alpha stage (which means: lots of bugs and performance issues), and contributions/PR to improve it are more than welcome.

Besides, please do not hesitate to submit new issues to the project's repository in order to signal bugs or missing features.

Acknowledgements

Ovide is a technology that was developped as a generic spinoff of several projects, notably funded by MESR/Université Rennes 2 and médialab Sciences Po.

See the peritext project website for more information about Ovide history.

Besides, it relies on numerous npm packages and libraries for which here are some acknowledgements :

• Sindre Sorhus sindresorhus@gmail.com (176 packages)
• Jon Schlinkert github@sellside.com (82 packages)
• Graham Fairweather xotic750@gmail.com (37 packages)
• Isaac Z. Schlueter isaacs@npmjs.com (35 packages)
• Kevin Mårtensson kevinmartensson@gmail.com (34 packages)
• Mike Bostock mike@ocks.org (34 packages)
• Unknown (31 packages)
• Titus Wormer tituswormer@gmail.com (29 packages)
• James Halliday mail@substack.net (28 packages)
• John-David Dalton john.david.dalton@gmail.com (28 packages)
• Jordan Harband ljharb@gmail.com (28 packages)
• Sebastian McKenzie sebmck@gmail.com (26 packages)
• Ben Briggs beneb.info@gmail.com (24 packages)
• TJ Holowaychuk tj@vision-media.ca (23 packages)
• Jeffrey Heer (21 packages)
• Tobias Koppers @sokra (21 packages)
• Robin de Mourat (20 packages)
• Unknown (19 packages)
• Mathias Buus mathiasbuus@gmail.com (19 packages)
• Jake Verbaten raynos2@gmail.com (18 packages)
• Fedor Indutny fedor@indutny.com (18 packages)
• Rebecca Turner me@re-becca.org (15 packages)
• Forbes Lindesay forbes@lindesay.co.uk (15 packages)
• Shinnosuke Watanabe snnskwtnb@gmail.com (15 packages)
• Sven Sauleau (14 packages)
• Shane Osbourne shane.osbourne8@gmail.com (13 packages)
• Domenic Denicola domenic@domenicdenicola.com (11 packages)
• Jonathan Ong jonathanrichardong@gmail.com (11 packages)
• Douglas Wilson doug@somethingdoug.com (11 packages)
• Felix Böhm me@feedic.com (10 packages)
• Vladimir Krivosheev (10 packages)
• Benjamin Lupton b@lupton.cc (9 packages)
• Vsevolod Strukchinsky floatdrop@gmail.com (9 packages)
• Joshua Appelman jappelman@xebia.com (8 packages)
• Calvin Metcalf calvin.metcalf@gmail.com (8 packages)
• Arnout Kazemier opensource@3rd-eden.com (8 packages)
• Mathias Bynens mathias@qiwi.be (8 packages)
• 2012+ Bevry Pty Ltd us@bevry.me (8 packages)
• Dominic Tarr dominic.tarr@gmail.com (8 packages)
• Matt DesLauriers dave.des@gmail.com (7 packages)
• JD Ballard i.am.qix@gmail.com (7 packages)
• Benjamin Coe ben@npmjs.com (7 packages)
• Joel Kemp joel@mrjoelkemp.com (7 packages)
• Feross Aboukhadijeh feross@feross.org (7 packages)
• JP Richardson jprichardson@gmail.com (6 packages)
• Simon Lydell (6 packages)
• Thomas Watson Steen w@tson.dk (6 packages)
• Mikeal Rogers mikeal.rogers@gmail.com (6 packages)
• Jake Luer jake@alogicalparadox.com (6 packages)
• Nathan Rajlich nathan@tootallnate.net (6 packages)
• Ben Newman bn@cs.stanford.edu (5 packages)
• Max Ogden max@maxogden.com (5 packages)
• Yusuke SUZUKI utatane.tea@gmail.com (5 packages)
• Mariusz Nowak medyk@medikoo.com (5 packages)
• Chris Talkington (5 packages)
• Paul Betts paul@paulbetts.org (5 packages)
• Julian Gruber julian@juliangruber.com (5 packages)
• Glen Maddern (5 packages)
• Charlie Robbins charlie.robbins@gmail.com (5 packages)
• Evan You (5 packages)
• Bogdan Chadkin trysound@yandex.ru (5 packages)
• Evgeny Poberezkin (4 packages)
• George Zahariev z@georgezahariev.com (4 packages)
• Tim Voronov ziflex@gmail.com (4 packages)
• James Talmage james@talmage.io (4 packages)
• Dave Gandy dave@fontawesome.com (4 packages)
• Jed Watson jed.watson@me.com (4 packages)
• Phil Booth (4 packages)
• Dan Abramov dan.abramov@me.com (4 packages)
• Toru Nagashima (4 packages)
• Andrew Clark acdlite@me.com (4 packages)
• Espen Hovlandsdal espen@hovlandsdal.com (4 packages)
• Kat Marchaán kzm@sykosomatic.org (4 packages)
• Sebastian Mayr github@smayr.name (4 packages)
• Andrey Popp 8mayday@gmail.com (3 packages)
• Luke Childs lukechilds123@gmail.com (3 packages)
• Sergey Slipchenko faergeek@gmail.com (3 packages)
• James Coglan jcoglan@gmail.com (3 packages)
• Irakli Gozalishvili rfobic@gmail.com (3 packages)
• Roman Dvornov rdvornov@gmail.com (3 packages)
• Andres Suarez zertosh@gmail.com (3 packages)
• Rod Vagg r@va.gg (3 packages)
• Mihai Bazon mihai.bazon@gmail.com (3 packages)
• Robert Kieffer robert@broofa.com (3 packages)
• Timothy Gu timothygu99@gmail.com (3 packages)
• Heather Arthur fayearthur@gmail.com (3 packages)
• Felix Geisendörfer felix@debuggable.com (3 packages)
• Maxime Thirouin (3 packages)
• Joshua Boy Nicolai Appelman joshua@jbna.nl (3 packages)
• Andrey Sitnik andrey@sitnik.ru (3 packages)
• Michael Jackson mjijackson@gmail.com (3 packages)
• Nicolai Kamenzky (3 packages)
• Cloud Programmability Team (3 packages)
• Nicholas C. Zakas nicholas+npm@nczconsulting.com (3 packages)
• Paul Miller paul+gh@paulmillr.com (3 packages)
• Rich Harris (3 packages)
• Thorsten Lorenz thlorenz@gmx.de (3 packages)
• Roman Shtylman shtylman@gmail.com (3 packages)
• Elan Shanker elan.shanker+npm@gmail.com (3 packages)
• Kyle E. Mitchell kyle@kemitchell.com (3 packages)
• Alex Lam alexlamsl@gmail.com (3 packages)
• Ingvar Stepanyan me@rreverser.com (3 packages)
• Marijn Haverbeke marijnh@gmail.com (3 packages)
• case case@casesandberg.com (3 packages)
• Dmitry Filatov dfilatov@yandex-team.ru (3 packages)
• James Kyle me@thejameskyle.com (3 packages)
• Michael Hart michael.hart.au@gmail.com (2 packages)
• Dom Christie (2 packages)
• Joyent, Inc (2 packages)
• Daniel Cousens (2 packages)
• freeall freeall@gmail.com (2 packages)
• Blake Embrey hello@blakeembrey.com (2 packages)
• Eran Hammer eran@hammer.io (2 packages)
• Tyler Kellen tyler@sleekcode.net (2 packages)
• michael mifsud xzyfer@gmail.com (2 packages)
• Jeffrey Heer, Dominik Moritz, Kanit "Ham" Wongsuphasawat (2 packages)
• Kirill Fomichev fanatid@ya.ru (2 packages)
• Ahmad Nassri ahmad@ahmadnassri.com (2 packages)
• Diego Perini diego.perini@gmail.com (2 packages)
• Alex Reardon alexreardon@gmail.com (2 packages)
• Benjamin Tan demoneaux@gmail.com (2 packages)
• Hugh Kennedy hughskennedy@gmail.com (2 packages)
• Roy Riojas (2 packages