Skip to content

tablecheck/tablekit

Repository files navigation

Next generation UI component library, view our docs at tablekit.tablecheck.com

Installation

nvm use
npm ci
npm start

Testing

npm run test

Development

Start the development server with npm run start

then visit http://<your ip address>:6060

Note the precommit script that will change your commit files according to prettier. If you want to know what will be changed we suggest setting up a IDE on save config.

Publishing Packages

Publishing packages is handled automatically via GitHub Actions

Building a package manually

  • Run lerna run build --scope=@tablecheck/tablekit-button

Creating new Packages

  • run npm run new-package and follow the prompts. This can take several minutes to correctly bootstrap the packages together after creation.
  • At this point everything should be ready to start developing with npm start
  • Continue modifying the files in the src folder as needed

Removing unsused packages

  • delete the package folder in packages/<package-name>
  • remove the entry for the package in .@tablecheck-react-systemrc.json

IMPORTANT! Before merging the MR, make sure the commit message has the scope of the component. Example: feat(newpackage): added New Package

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Wahid Magdy

📖 💡

Simeon Cheeseman

🚇 💡 💻 ⚠️ 📖

irmir

💡 💻

Joan Mira

📖 💻

Johnny Shields

📖

Dmitriy

💡 💻

Daniel Lizik

💻

Alex

💻 💡

This project follows the all-contributors specification. Contributions of any kind welcome!