Field Meta Editor

A web application, it is designed for the previewing and editing of the primitive field information of the imported data, generating detailed field configurations for the exploitation within @kanaries/graphic-walker.

Usage

Prerequisites

1. Golang

Golang is the programming language used to develop the backend of this monorepo.

Install Golang (version >= 1.16.0).

On Mac OS, you can use Homebrew to install Golang:

brew install go

You can also install the Golang IDE GoLand (version >= 2020.3.3).

2. Node.js

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. It is used to run the main workflow of this monorepo.

Install Node.js (version >= 14.0.0).

On Mac OS, you can use Homebrew to install Node.js:

brew install node

On Windows, you can visit the official website to download the installer.

3. Yarn

Yarn is a package manager for JavaScript projects. It is used to manage dependencies of the frontend and execute scripts in this monorepo.

Install Yarn (version >= 1.22.0).

Using npm:

npm install -g yarn

Install dependencies

# execute the following command in the root directory of this monorepo, it will install dependencies for all packages
yarn install

Start the backend

# start the server
yarn workspace meta-service start

Start the web application

# serve with hot reload
yarn workspace web-app dev

Configure the backend

Edit the file packages/web-app/.env to configure the backend.

VITE_SERVER_HOST = http://localhost:3000