Redoute 📚

Redoute is an UI kit. It allows you to install and import small components for your interface.

Packages are located in src/packages.
They are independents.

Online doc : redoute.dataveyes.com

All components are listed in the doc

yarn run docz:dev

Dev zone 👩‍💻

How to create/update and publish a repository

1. Create a new folder for your package/components in src/packages
2. Develop your components
3. Write the document in a .mdx file & check in the docz website (If needed install it localy, see chapter about yarn link)
4. Push and create a Pull Review for a peer to check (do not merge yet!)
5. When the review is finished, squash/rebase the history to have a clean history.
6. Pull the last version of master on your branch, publish the version by running yarn run publish (you may need to run yarn login first)
7. Push that commit to your branch (it may has been pushed automatically with the previous command)
8. Merge this branch

yarn link : Install a package from a local path (without publishing it) ?

Init the link:

cd src/packages/my-package
yarn link

Install the new package where you want to use it:

yarn link @redoute/my-package

More about yarn link