Skip to content

running-development-version.md

Latest commit

 

History

History
48 lines (33 loc) · 1.93 KB

running-development-version.md

File metadata and controls

48 lines (33 loc) · 1.93 KB
Raw

Running development version

To develop evitaLab, you need to know how to run it in the development environment.

Before you start, make sure you have Node.js installed in the version specified in .nvmrc and Yarn package manager installed.

Then you can run it either in standalone mode:

yarn install
yarn dev

this will start a development server on localhost:3000/lab address.

Or the driver mode (for evitaLab Desktop):

yarn install
yarn dev-driver

this will start a development server on localhost:3000 address.

By default, the development version of evitaLab starts with a connection to the evitaDB Demo server. You can change it in the .env.local file by modifying the VITE_DEV_CONNECTION variable. Right now the following values are supported:

  • DEMO - connects to the evitaDB Demo server
  • LOCAL - connects to a local evitaDB server running on the default port 5555 (override the URL with VITE_DEV_LOCAL_URL)

To switch for a single run without editing .env.local, use yarn dev:demo or yarn dev:local (yarn dev-driver:demo / yarn dev-driver:local in driver mode) — a VITE_* variable from the shell environment overrides the .env files.

To spin up a local Dockerized evitaDB (matching the dev integration branch via the canary tag by default) and run vite against it. The data directory is mandatory — there is no default, because it decides which catalogs the server sees:

./scripts/evitadb-server.sh start --data-dir /path/to/evita-data
yarn dev:local

The container lifecycle (status, logs, stop, custom evitaDB properties) is handled by the same script and documented in evitaDB server.

To build the production version of evitaLab, check out the building from source section.