General Nordcloud UI
This repo contains the Nordcloud Design System - a collection of reusable React components used in Nordcloud's SaaS products.
Components
- Design System (
/src/components) - Storybook (
/src/stories)
Install
npm install @nordcloud/gnui
or
yarn add @nordcloud/gnui
Storybook deployment
Storybook allows you to preview components. It deploys the code automatically with Amplify Console triggered by changes on branch master. Pipeline steps are found in amplify.yml.
When you create a PR against the master branch, Amplify creates a new deployment automatically - the environment will be attached to the PR at Github. Reviewers can preview changes using this deployment - after the PR gets merged or rejected, the environment is destroyed automatically by Amplify Console.
Contributing to this repo
- Please create your components in
src/componentsand update stories instores. - Code should be formatted using Prettier.
- We are using styled-components for styling.
- All code should be written using TS.
- Every component props should be described using "type" instead of "interface".
- Name types with Pascal Case naming convention and Props or Data prefix.
Local setup
- git clone this repo
npm installnpm run storybook
Development
- Make sure to check out Storybook Design System
Local testing
There is a possibility to build & test the package locally in the project it's currently used in.
npm run compile:publish
npm pack
You will get a tarball with the freshly built package, you can copy it inside your project's folder and install with
npm install nordcloud-gnui-${VERSION}.tgz
After the successful installation it's ready to be tested (remember to restart the dev server)
Contributors
 raczyk |
 Dominik N |
 Jan Osio |
 Horay |
This project follows the all-contributors specification. Contributions of any kind are welcome!
License
Licensed under the MIT License, Copyright © 2020 Nordcloud Engineering
See LICENSE for more information.