Lodex

Lodex is a tool facilitating the publication of a dataset in various formats, including csv, tsv, xml, json, among others. The platform also offers features to manipulate the data in a back-office environment.

To see what Lodex can do, please refer to the website at https://data.istex.fr/ or consult the user documentation available at https://lodex.inist.fr/docs/.

Installation

To use Lodex, you must install Docker and Docker Compose. You can install them both through the Docker Desktop application.

Development

Clone and install

git clone https://github.com/Inist-CNRS/lodex.git
cd lodex
make install

Run dev server

make run-dev

Go to http://localhost:3000/instances and log in using the credentials root/secret. From there, you can create a new instance (tenant) on the instances page in order to publish new datasets and models.

Note: Upon instance creation, the default user/password combination is set to admin/secret.

Run test suite

Different tests can be run to verify that changes made to the source code at various levels do not cause any issues in the application.

• The test-unit suite focuses on testing individual functions and systems without considering the entire application.
• The test-api-e2e suite aims to test the API without taking the frontend into consideration.
• The test-e2e suite's goal is to test various scenarios with both the frontend and backend in mind.

make test-unit
make test-api-e2e
make test-e2e # Those tests may take up to 30 minutes to complete.

make test # Run all of the above tests

Note: You can disable end-to-end tests in the make test command by setting the DISABLE_E2E_TESTS environment variable to true.

Production

You can create an instance via four methods.

Github

git clone https://github.com/Inist-CNRS/lodex.git
cd lodex
make start

GitHub Release

wget https://github.com/Inist-CNRS/lodex/archive/refs/tags/v14.0.18-alpha.zip
unzip v14.0.18-alpha.zip
cd lodex-14.0.18-alpha
make start

EzMaster

EzMaster is a Docker orchestration tool designed for non-technical administrators. To install Lodex in EzMaster, you should download the image (inistcnrs/lodex) through the applications menu. Once the image has been loaded, you can create a Lodex instance through the Instances menu.

Docker Hub

docker pull inistcnrs/lodex
docker run -it inistcnrs/lodex

Useful links

• Data and Model ready to use: https://github.com/Inist-CNRS/lodex-use-cases
• User Documentation: https://lodex.inist.fr/docs/ (French Only)
• Lodex home page: http://www.lodex.fr/
• Contribute (for developer): https://github.com/Inist-CNRS/lodex/wiki
• Contact: https://www.lodex.fr/contact/

Licence

This software is CeCILL license. You can use, modify and/ or redistribute the software under the terms of the CeCILL license.

We also use the following icons :

• Big data by Eliricon from the Noun Project
• bubble chart by Kirby Wu from the Noun Project
• diagram by TheFit Project from the Noun Project
• Heat Map by Sophia Bai from the Noun Project
• Pie Chart by Gregor Cresnar from the Noun Project
• Radar Chart by Agus Purwanto from the Noun Project
• statistics by Creative Stall from the Noun Project
• Add table by Danil Polshin from the Noun Project
• Add filter icon by Jivan from the Noun Project

Thanks to the noun project and their respective creators