eyf-embed-code v1.0.5
Empty your fridge embed code component library
This repo is built with rollup into a reuseable component that can be installed directly from our plantjammer github repo.
Getting Started with eyf-embed-code
Start development
run yarn dev in order to start up storybook and make modifications to the library
Why only storybook for development?
Because this component library is meant to be used in other react projects with material ui the dependencies are included only as devDependencies and peerDependencies. Therefore you can NOT run it as a normal react app. in order to develop
How to contribute
Please follow the notes in genetors.ts and codeblocks.ts in order to add or modify a code-snippet to the component.
Furthermore make sure to update and add tests to any modification as this component is used in more than one parent repo, so proper testing and test-coverage is vital
Create a feature branch and once step 1 and 2 are done open a PR to master branch
The build step
Linting, testing and building AND staging the ./build folder happens automatically via husky git hooks before each commit. This is to ensure that we remember to build and test before each release to master.
git commit -m 'message' should trigger the pre-commit hook. If you need to bypass that can be done with the --no-verify flag but this is discouraged. All you need to do after committing is pushing.
run yarn build to build the project to the /build folder