common-ui

Shared components, styles and themes for TurnKey front-end applications

Installation

npm install -S @turnkeyvr/common-ui

To upgrade, run npm install -S @turnkeyvr/common-ui@latest

This library should house all common components, styles and themes that can be shared between TurnKey applications.

Using the library

This library should be used to import the Material UI theme and pass it to the appropriate theme provider for your application.

Import components directly from the @turnkeyvr/common-ui package:

• import { TextInput } from '@turnkeyvr/common-ui

For more details, check out the Design System Storybook.

Development

Standards

The standards below are ever-evolving as we work on this application. If you have any thoughts or ideas on these standards please bring them up with the other developers.

This library is all about collaboration so it is important that we all agree on what these standards are!

The common library is build on the following technologies:

• Create React Library: Structure generated by create-react-library
• React: All components are react components
• Material UI: CSS/Design framework that we are expecting the consumer to use
• Typescript: This library will use Typescript with basic standards/configuration to enforce consistency across collaborative development.
• Storybook: Used for component development in isolation. Allows us to work with design to create a common language when developing applications.
• Rollup: Rollup is used to create the distribution files that will be published to npm.

We expect the following basic standards for developing in this library:

• Trunk based development conventions are closely followed
• All non-trivial changes to main go through peer review
• There must be consensus between design/development before publishing a component to the library

Running the library

To develop the library, we will use a local instance of storybook. All you have to do is simply run npm run storybook and, after the application is build, you will have a local instance of storybook running at localhost:6006.

Deploying the library

Please see the wiki section on deployment for detailed steps on how to deploy a new version of the library to npm.

Test