☁️ Nimbus Design System

Nimbus is an open-source Design System created by Tiendanube / Nuvesmhop’s team to empower and enhance more stories every day, with simplicity, accessibility, consistency and performance.

📚 Documentation

Check out our documentation site for detailed guidelines and resources.

We use Storybook as our front-end library to provide a full interactive playground for testing and building components.

You can browse through our playground to test and see our components in action.

🚀 Installation

• Install

  $ npm install @nimbus-ds/name-component
  
  // or
  
  $ yarn add @nimbus-ds/name-component

💻 Start developing

• Install dependencies

  Get all dependencies installed by running

  $ yarn

• Setting up the project

  $ yarn prepare-husky

• Start developing

  Start the local environment with

  $ yarn start:dev

📚 General informations

To standardize our commits we use Conventional Commits a specification for adding human and machine readable meaning to commit messages

• Naming standards

  # commit
  feat: description

• Linter

  # find problems
  $ yarn lint
  
  # find and fix problems automatically
  $ yarn lint:fix

• Unit tests

  # run all unit tests
  $ yarn test
  
  # run all the tests and watch for changes in related files
  $ yarn test:watch
  
  # run tests only on changed files
  $ yarn test:staged
  
  # run all unit tests generates the coverage report in the coverage folder in the project root
  $ yarn test:coverage
  
  # run all unit tests generates the coverage report in the coverage folder in the project root and watch changes in related files
  $ yarn test:watch:coverage

• Hooks

  This project has these hooks:

  • pre-commit: perform static code analysis with eslint
  • commit-msg: validates the commit message according to the convention adopted by the project
  • pre-push: perform unit testing of project components and integration tests

🖥️ Release process

While our release schedule is flexible, our general strategy is to release several larger improvements inside each stable release. In order to provide faster access to fixes and enhancements between main releases we provide release candidates which are published on every merge into master. The step by step to perform a release release can be found at the link.

🔗 Useful links

• Design Tokens. We use tokens to store all our primitives (colors, spacing values, grid system, etc.).
• Nimbus Icons. Our very own open-source icon library.

🤝 Contributing

We encourage all ideas, suggestions and feedback. If you want to collaborate with us, start by reading our contribution guidelines.

📄 License

Licensed under the MIT License, Copyright © 2022-present Tiendanube.

See LICENSE for more information.