@nordcloud/gnui

πŸ’… Nordcloud's design system for SaaS products.

Showing:

Popularity

Downloads/wk

510

GitHub Stars

17

Maintenance

Last Commit

5d ago

Contributors

22

Package

Dependencies

39

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

All Contributors

General Nordcloud UI

This repo contains the Nordcloud Design System - a collection of reusable React components used in Nordcloud's SaaS products.

Components

  1. Design System (/src/components)
  2. 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/components and update stories in stores.
  • 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 install
  • npm run storybook

Development

Local testing

There is a possibility to build & test the package locally in the project it's currently used in.

npm run build
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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100