Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.39 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.39 KB

TIND Components Library

Based on:

React TypeScript PrimeReact PrimeIcons Storybook

Development

To start the project locally, close the repository and run the following:

npm install
npm run storybook

Deployment

CI/CD pipeline will automatically trigger a build & deploy jobs on every push or merge to master branch.

If for whatever reason the build doesn't start automatically, you can trigger it manually through this AWS CodeBuild job.

Deployed storybook will be available on https://storybook.tind.io

Publishing

To publish the library on NPM, make sure you're part of the tindtechnologies organisation and run the following command:

npm run :publish

Structure

The project is split into 2 distinct sections:

  • components library
  • storybook app

Components library

Used as an entrypoint for all future TIND 2 components. Based on React and PrimeReact and hosted on npm registry.

Storybook app

Designed for development and testing of the components library, this app helps with local development and iterative design of components.