Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.63 KB

README.md

File metadata and controls

54 lines (38 loc) · 1.63 KB

Debezium UI

This monorepo uses Lerna and npm Workspaces. React-based Single Page Application code based on Patternfly 4 in present inside ui folder.

Requirements

  • node (version 16.x.x or higher) and npm (version 8.x.x or higher).

Development workflow

This will install all dependencies in each project, build them, and symlink them via Lerna

npm install

Run a full build

npm run build

Start the development server

npm run start

Internationalization

This project uses react-i18next for internationalization. Check out the existing examples in the code or the documentation for more information on how to use it.

You should run

npm run i18n

after you internationalize strings in order to generate the required files.

Namespaces other than 'public' must be added to i18n.ts on line 31.

If you want to add an additional language, you need to add locale to line 51 in i18next-parser.config.js (managed by the parser).

Testing the project

Testing is also just a command away:

npm run unit:test

This command runs Jest, an incredibly useful testing utility, against all files whose extensions end in .test.ts. Like with the npm run start command, Jest will automatically run as soon as it detects changes. If you'd like, you can run npm start and npm run unit:test side by side so that you can preview changes and test them simultaneously.

Configurations