design_system is the central repository to manage our UI components. This should lead to a straight forward separation of concerns, so that UI logic keeps within the component library and business logic will be added in the actual application. This way we can guarantee a specific degree of consistency across all our applications, rapidly speed up our development process of frontend applications and even achieve a high degree of customization by overwriting the theme object.

Note: This project was bootstrapped with Create React App.

Installation

Install from the command line:

yarn add @anynines/design-system

Install via package.json:

"@anynines/design-system": "^0.3.0"

Development

Clone the GitHub Repo locally, then run

yarn install

Run this to build the package (before an update in external repo), important after changing components or other configurations:

yarn build

Testing

In the project directory, you can run:

Run this to start the storybook application

yarn storybook 
# or
yarn sb

Run this to ensure it is correctly packaged

yarn start

Run this to start the Test Suite

yarn test

Launches the test runner in the interactive watch mode.

See the section about running tests for more information.

Production

It automatically deploys the design_system if you push a commit on the master-branch.

For a manual Deployment you need to build the application first with

yarn build

Check if the dist Folder has the completed build in it (should include all Components). Only the dist-folder needs to be deployed (if you want to add a folder to the deployment you need to add those in the package.json in the files-array).

If your test-suite is also okay you can publish the build via

yarn publish

Learn More

You can learn more in the Parcel documentation.

To learn React, check out the React documentation.