do•doc (or dodoc) is a documentation tool, first designed for use in classrooms with children. It is a platform connected to a physical device that operates a camera and a microphone, and enables one to capture traces from an on-going experience for later reflections, reconstructions and creation of narratives.
do•doc is made by l'atelier des chercheurs (Sarah Garcin, Pauline Gourlet & Louis Eveillard).
- in english: https://latelier-des-chercheurs.fr/en/tools/dodoc
- en Français : https://latelier-des-chercheurs.fr/outils/dodoc
do•doc is free and open source. The code is licensed under AGPLv3, and the graphic assets (icons, pictograms, user interface) are under a CC-BY-SA license.
Method 1 — the easy way
Download the latest release from the release page.
Method 2 — the long way
1. Download this repository
Click on Clone or Download in the top right corner of this page, then Download ZIP. Unpack this folder.
2. Open a terminal window
Open a terminal window:
- Windows: (XP) use this tutorial to open a terminal on Windows or open Command Prompt in the start menu
- macOS: go to Applications -> Utilities -> Terminal
- Linux: use a terminal app such as Terminal or Konsole
In your terminal, navigate to the dodoc-master folder with your terminal using the
3. Install dependencies
If you haven’t already, install the tool that will enable native modules to be used. To do this, follow the instructions here: https://github.com/nodejs/node-gyp
Then, install do•doc’s dependencies (may take up to 5 minutes):
4. Run do•doc
Start from the folder in a terminal window with the following command:
Most install errors (and especially the Module version mismatch. Expected 50, got XX.) are due to native packages such as sharp, a powerful image manipulation library.
The first thing to check is whether you use the right version of node.js: it must be version 8.9.3.
To know the version you are running, write
node -v in a terminal window.
The reason you have to use this version of node.js is because this app uses Electron, a tool to package node.js and a webbrowser as native apps. The version of Electron this app is using is version 2.0.5, and it uses node version 8.9.3. However, when native modules are built, they are built using the local node version and not Electron’s. Hence, you have to run the exact same version as Electron to prevent this type of error to happen.
Here are a few other things you can try (but only after making sure you run the right node version):
Sometimes, Electron is not installed when running
npm installon the repo. It may help to run
npm install firstname.lastname@example.org to be sure it is actually installed locally.
Follow the instructions here, and specifically:
# Electron's version. export npm_config_target=2.0.5 # The architecture of Electron, can be ia32 or x64. export npm_config_arch=x64 export npm_config_target_arch=x64 # Download headers for Electron. export npm_config_disturl=https://atom.io/download/electron # Tell node-pre-gyp that we are building for Electron. export npm_config_runtime=electron # Tell node-pre-gyp to build module from source code. export npm_config_build_from_source=true # Install all dependencies, and store cache to ~/.electron-gyp. HOME=~/.electron-gyp npm install
- electron-builder (which builds electron to an app) embeds a script that rebuilds dependencies according to electron. To use it, write:
sharp on ubuntu
It seems the dependency sharp cannot be built easily on Ubuntu. Install an older version to fix this:
npm install email@example.com
Tweak, fork and debug
npm run debugto start the server with a better debug in terminal
The client-side code is in the
public folder. To write some new CSS or client-side JS, you need to run the following tasks:
npm run install
and then, to start the dev tasks:
npm run dev
To build for production, use
npm run build
This will create minified JS files in the