Boilerplate for pdor generator to generate a react component.
- Build: create production-ready distribution file, also UMD
- Documentation: create different documentation for each version
- Lint: check the quality of your code
- Test: test your code and check the code coverage
- Example: try your library with examples
- Storybook: try your React component with Storybook
- Continuous Integration: set your continuous integration environment with Travis CI
npx @docomodigital/pdor my-app -t react-component
cd my-appPlease refer to the pdor documentation for more info
- Edit source code and test of your Component, contained in src/
- Check the quality of your code with
npm run lint - Run tests with
npm run test - Check the coverage of your tests with
npm run test:open - Try your Component with examples contained in examples/, with
npm start - Try your Component with storybook, with stories contained in stories, with
npm storybook - Create the documentation and read it with
npm run doc:open - Integrate your Component with Travis CI, using .travis.yml
- Publish your Component on NPM
You can find all commands for develop, maintain and publish your library on CONTRIBUTING file.
- Webpack
- Babel
- React
- JSDoc
- Minami JSDoc Template
- ESLint
- React Styleguide
- Jest
- Coveralls
- Travis CI
- Storybook
- Jenkins configuration