Skip to content

Holusion/eCorpus

Repository files navigation

eCorpus

Description

This is the code repository for eCorpus, a content management system by the eThesaurus consortium.

Installation

If you happen to have access to a running eCorpus instance, simply follow the Quick Start Guide.

This guide is also available in french.

You can otherwise head over to a Standalone "sandbox" scene on our test server or learn how to spin up your own eCorpus instance.

Project Goals

eCorpus aims to provide a management layer over the DPO-Voyager Open Source 3D explorer and authoring suite. It has built-in history revision management, users roles with access controls and service management capabilities.

We strive to make the software as lightweight and interoperable as possible.

Development

Testing eCorpus

eCorpus uses a two-stage testing strategy :

  • Unit tests and Integration tests for server side logic and APIs that aims to catch any security and reliability issues. Those tests are found withing the repository under source/server/**/*.test.ts
  • End to End tests run on an automated browser environment that aims to ensure actual usability of the software.

Repository structure

The repository uses recursive submodules, because the upstream DPO-Voyager uses them.

It means some commands will need to be run with the --recurse-submodules flag, or you will need to run git submodule update --init --recursive after cloning the repository.

eg: git clone --recurse-submodules [email protected]:Holusion/eCorpus

Day-to-day operations can be simplified by configuring git (globally or for thsi repository) to always recurse by default : git config submodule.recurse true.