@engyalo/react-yalo-components
v2.0.4
Published
react library with reusable components
Downloads
227
Maintainers
Keywords
Readme
⛔️ DEPRECATED
This project has been deprecated, if you need a component or help with one in this library please reach yalo eng team
React Yalo Components
This project contains multiple reusable componentes based on Yalo Design guidelines.
Getting started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. ˚
Try the project before publishing it.
You might need to test the library within the context of an app. This library installs react and react-dom to be able to run, but when mixed with other projects that also have these libraries in particular tests might start failing. The following steps will solve that issue: As an example, we will use App1 as the name of the app we want to try our library in._
pushd
App1/node_modules/react- yarn link &&
popd
pushd
App1/node_modules/react-dom- yarn link &&
popd
pushd
react-yalo-components/- yarn link react
- yarn link react-dom
- yarn link &&
popd
- cd App1/
- yarn link @engyalo/react-yalo-components
pushd
and popd
are replacements for cd
... that are programmatically capable to go back to where you started before using cd
if you are interested in further reading about why we need to do all this, please read the following issue.
another alternative is to "pack" the changes into a .tgz file.
pushd
react-yalo-components/- make all the changes you want
yarn build
npm pack
popd
pushd
App1/- yarn add path/where/react-yalo-components/react-yalo-components-[major]-[minor]-[fix].tgz
Run project
After having all the dependencies you can run
yarn storybook
Runs storybook command to open a UI where you can play with all the components the library has.
The page will reload if you make edits. You will also see any lint errors in the console.
Running the tests
To run test just run
yarn test
Build
To build components we use Bit as component manager so each of the component is upload independently.
Dependencies
This project uses:
- Styled Components to style HTML.
- Jest and Testing Library for tests
- Redux as state manager