Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.8 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.8 KB
Raw

TermIt UI

Netlify Status

TermIt is an advanced terminology management tool compatible with SKOS. This repository contains the frontend of TermIt. Backend is written in Java and is developed separately (its repository can be found here).

More info about TermIt can be found at its Web - http://kbss-cvut.github.io/termit-web.

TermIt UI is written in TypeScript using React.

This project was bootstrapped with Create React App, TypeScript version.

Documentation

Documentation for developers and system administrators is in the doc folder.

Running TermIt UI

NodeJS 20 and npm 10 are required to build and run TermIt UI. To run the TermIt UI, it is necessary to provide a value for REACT_APP_SERVER_URL representing the URL of the backend to connect to. Typically, this is done at build time. See the documentation for more details and other configuration options.

Dockerization

The docker image of TermIt UI can be built with docker build -t termit-ui .

Then, TermIt UI can be run and exposed at the port 3000 as docker run -e SERVER_URL=<TERMIT_BACKEND_URL> -p 3000:80 termit-ui where <TERMIT_BACKEND_URL> denotes the URL where TermIt backend is running.

Other Docker runtime configuration parameters are: DEPLOYMENT_NAME, ADMIN_REGISTRATION_ONLY, and SHOW_PUBLIC_VIEW_ON_UNAUTHORIZED. See doc/setup.md for their explanation.

License

Licensed under GPL v3.0.