Giter Club home page Giter Club logo

gnui's Introduction

All Contributors

General Nordcloud UI

This repo contains Nordcloud PAT Design System - a collection of reusable react components that can be used in PAT products.

Components

  1. Design System (/components)
  2. Storybook (/stories)

Usage

[WIP] Install github package.

Storybook deployment

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.

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

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.

gnui's People

Contributors

khola avatar raczyk avatar jphawk avatar horay avatar nowydev avatar janosio avatar allcontributors[bot] avatar daniel-choinski avatar aittomakia avatar bahroze-dev avatar tdi avatar gagansingh5 avatar idirmosh avatar jeremy-walton avatar mykolakolotylo avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.