nrich-frontend
React monorepo providing bindings to simplify the integration with nrich libraries.
The overall project is built on top of the concept of Yarn workspaces using Turborepo as a build management system.
For the demonstration of the integrations provided here, please visit the nrich-demo-frontend repository.
Workspace/module overview
Workspace is divided in config and libs subcategories.
config contains common configuration used throughout the libs implementations.
libs contains implementation of specific modules separated in two categories. First is a core module which contains common logic
and custom hooks for the module. Second are adapters for specific UI component library, currently only mui.
The following workspaces/modules are available:
- @croz/nrich-form-configuration-core - contains the core utilities for using nrich form-configuration module
- @croz/nrich-notification-core - contains the core utilities for handling common state operations for the nrich notification module
- @croz/nrich-notification-mui - contains the UI implementation of notifications for the MUI component library
Development of new modules
When developing a new module, the workspaces are to be organized as in the example:
libs/foo-core, wherefoois the name of the module matching the naming conventions of the complementary backend modulelibs/foo-bar, wherefoois the name of the module matching the naming conventions of the complementary backend module, andbaris the name of the UI component library
Common commands
Build
To build all modules, run yarn build.
To build specific module(s), run yarn build -filter=foo, where foo is the workspace name (e.g. @croz/nrich-notification-core).
This specific command receives a variable number of arguments.
Clean
To clean build artifacts, run yarn clean.
Lint
To execute the linting process in a read-only mode (without actually affecting the files), run yarn lint.
To automatically apply changes, run yarn lint --fix.
Test
To run tests, use yarn test.