evitaLab

evitaLab is the official web-based GUI client for evitaDB e-commerce database. Visit demo.evitadb.io for the live demo.

evitaLab aims to provide a user-friendly client for evitaDB database to easily browse data stored in the database. In the future, evitaLab will hopefully also allow data modifications.

You can try out evitaLab with evitaDB demo dataset at demo.evitadb.io.

Features

evitaLab is currently in early development stage, and features are being added as we go.

evitaLab allows you to:

• [x] inspect schemas
• [x] browse entities in interactive table
• [x] execute GraphQL queries
• [x] execute evitaQL queries
• [x] visualise extra results
• [x] manage connections to multiple evitaDB instances

Running locally

To run evitaLab locally, you can use either of the following ways. In the future, we plan to provide pre-built binaries for all major desktop platforms, but currently the docker image is the closest thing we have.

Embedded in local evitaDB instance

The easiest and quickest way to run evitaLab locally is to enable it inside your configuration of evitaDB. By default, evitaDB will automatically expose its own local evitaLab instance on the localhost:5555/lab address. For more configuration, see evitaDB documentation.

Docker

The easiest and quickest way to run evitaLab locally without running evitaDB is to use Docker. You can use the following command to install evitaLab locally:

docker run --name evitalab -ti -p 5566:3000 ghcr.io/lukashornych/evitalab:latest

Next time you want to run the evitaLab, simply start use:

docker start evitalab

This will expose an evitaLab instance on localhost:5566/lab address.

From dist

If you want to run evitaLab manually, you can download the latest release from releases page and use any static web server to serve the files from dist directory. For example, you can use nginx

From source

If you want to run a development version of the evitaLab, you can clone this repository.

Before you start, make sure you have Node.js v18.16.1 installed. Optionally, you can also install Yarn package manager.

# running using npm
npm install
npm run dev

# running using yarn
yarn install
yarn dev

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

Development

If you would like to contribute to evitaLab source code or just simply play with it locally, you just need to clone the project, install the Node.js v18.16.1 (you can also install Yarn as that's what we use for development) and run the following commands to run the evitaLab locally:

# running using npm
npm install
npm run dev

# running using yarn
yarn install
yarn dev

Licence

Apache License 2.0

Contribution

Any contributions are welcome and appreciated. If you would like to contribute to evitaLab, feel free to open an issue and submit a pull request. However, keep in mind that this project is still in an early development stage and features may change or be completely removed.