Quick Installation

This section requires some familiarity with common development tools: git, npm.

This section provides an example of creating a minimal instance of eCorpus for testing purposes. To do so, follow these steps:

git clone --filter=blob:none --recurse-submodules git@github.com:Holusion/eCorpus
cd eCorpus
npm i
(cd source/voyager && npm i --legacy-peer-deps)
(cd source/server && npm i)
(cd source/ui && npm i)
npm run build-ui
npm run build-server
npm start

Note: For an alternative installation method using Docker, refer to the installation documentation.

After completing the above steps, open a browser and navigate to localhost:8000 to access the eCorpus instance.

Creating the first user account

When the application is launched, it is in “open mode”, which allows you to create a first user account via the command line. To create an account, follow these steps:

Start your local server.

Open another terminal and run the following command:

curl -XPOST -H "Content-Type: application/json" -d '{"username":"<...>", "password":"<...>", "email":"<...>", "isAdministrator": true}' "http://localhost:8000/api/v1/users"

Replace <...> with your desired username, password, and email address. Other accounts can be created via the web interface.

Going further

After creating your first user account, navigate to localhost:8000 and log in.

From there, you can create your first scene by following the instructions provided in the Voyager import tutorial.

If you want to edit the source code, refer to the development guide.

To configure your new instance, consult the configuration documentation.