A placeholder for making open source react components/library
npm install a-react-library
import { MyComponent } from 'my-component';
// ...
<MyComponent myProp="myValue" />
A component example
Property | Type | Required | Default value | Description |
---|---|---|---|---|
myProp | string | yes | A random prop |
You should use YARN for development as NPM seems to be causing some issues! (Using NPM for just installing and using as a component is OK)
yarn start
for live-testing the demo app
yarn storybook
for live-testing the storybook app
yarn github-page
for testing a temporary build of the full github-page without an possible theme that you will choose later on GitHub (no live-testing)
yarn generate-readme
Will generate a readme according to your package.json info and the following files :
-
- setup_readme.md (if not present, it will use the default
npm i YOUR_PACKAGE_NAME
)
- setup_readme.md (if not present, it will use the default
-
- usage_readme.md
-
- dev_readme.md
You can then edit your readme.md file if you need to before building/publishing/deploying
yarn publish
Will transpile and publish to npm, it will prompt you the version incrementing.
yarn build
Will build the static demo and storybook apps for prod into the build folder
yarn deploy-github-page
Will deploy the built apps from 'build' folder to the 'gh-pages' github branch
yarn build-and-deploy
This helper script will call all the scripts for a complete GitHub building and deploying (yarn build && yarn deploy-github-page
)yarn publish-build-and-deploy
This helper script will call all the scripts for a complete NPM and GitHub transpiling/building and publishing/deploying (yarn publish && yarn build-and-deploy
)
You should then commit and push sources on GitHub the usual way.
This document was generated by the Create React Readme v1.0.7.