Enveritas Component Library (React)

Questions or feedback?

• Reach out to the Enveritas Frontend Team

Recommended

• nvm for node version management

Useful Commands

• npm ci - installs all required packages
• npm run options:
  • create-component - follow the prompts and it will generate a new component folder and boilerplate files to get you started.
  • dev - runs Storybook in development mode
  • test(*) - runs jest tests
  • build(*) - builds the component library
  • build-storybook - builds the static storybook application
  • lint(*) - runs code quality checks
    • Recommended: use the --fix flag to have the linter automatically amend and prettify the project

(*) = command runs on git commit as well

Design References

• Enveritas Design Tokens
• Envertias Design System

Development Setup + Etiquette

• Conventional Commits are enforced, see the linked documentation for reference or ask if you have questions about specific usage
• Each component must be generic and self-encapsulated. This means it should provide a clear, customizable API through props, use scoped styling to prevent conflicts, and include all necessary logic internally. The component should be designed to function predictably in any React project without assuming external configurations or styles.
• Components should have jest test coverage for basic functionality at minimum and ideally include edge case coverage as well. Snapshot testing is not currently included, but could be added in the future.
• When creating a PR, add the Frontend Team plus Stefan and Fabian as reviewers. Ideally approval should come via at least one team member per discipline (Frontend Team + Design Team)

Troubleshooting

At time of writing there is limited feedback for issues during setup or development, but if you encounter issues you're incouraged to update the readme or reach out to us directly!