This repo contains Nordcloud PAT Design System - a collection of reusable react components that can be used in PAT products.
- Design System (
/components
) - Storybook (
/stories
)
[WIP] Install github package.
Storybook allows you to preview GNUI components. It deploys automatically using Amplify Console, triggered by changes on branch master
. Pipeline steps can be found in amplify.yml
.
When you create PR against master
branch, Amplify will create new deployment automatically - the environment will be attached to 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.
- Please create your components in
src/components
and 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.
- git clone this repo
npm install
npm run storybook
raczyk |
Dominik N |
Jan Osio |
Horay |
This project follows the all-contributors specification. Contributions of any kind are welcome!
Licensed under the MIT License, Copyright ยฉ 2020 Nordcloud Engineering
See LICENSE for more information.