Install a development instance

Install a development instance#

Prerequisites#

In development, souslesensVocable needs a Virtuoso instance, an ElasticSearch instance and a Sql and a Spacy server. We provide a docker-compose.dev.yaml to deploy this dependencies.

SouslesensVocables is deployed locally using node and npm.

Docker#

Install docker for linux fin ollowing this link.

Install docker for windows in following this link.

Node#

Install nodejs for linux from the nodesource package repository (detailed instruction here).

Install nodejs for windows in following(detailed instruction this link).

Prepare the souslesensVocables git repository#

Clone the git repository

git clone https://github.com/souslesens/souslesensVocables.git
cd souslesensVocables

Checkout the latest release

git checkout x.x.x  # replace with release number (e.g. 1.95.0)

Optional : Prepare the sls-py-api git repository#

Clone the git repository

git clone git@github.com:souslesens/sls-py-api.git
cd sls-py-api

Checkout the latest tag

git checkout x.x.x  # replace with release number (e.g. 1.4.0)

Optional : Prepare the jowl git repository#

Clone the git repository

git clone https://github.com/souslesens/jowl.git
cd jowl

Install npm dependencies#

npm ci

Configure#

Run the config script to create a default configuration:

node scripts/init_configs.js

Start docker dependencies#

Start the servers with docker compose

docker compose -f docker-compose.dev.yaml up -d

Load some data into virtuoso

bash tests/load_data.sh dev

Run migration scripts#

Certain version need migration of data. See CHANGELOG.md before upgrading.

To run migration scripts you need to use the command

npm run migrate

At project root

Under Windows need to use git bash to run this script

cd project-root
npm run migrate

Run souslesens server (dev mode)#

The following command will build and watch the react app and run and watch the node app.

npm run build

npm run start

SouslesensVocables will be available at localhost:3010.