Boilerplate for pdor generator to generate a Typescript library.
- 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
- Continuous Integration: set your continuous integration environment with Travis CI
npx @docomodigital/pdor my-app -t typescript
cd my-app
Please refer to the pdor documentation for more info
- Edit source code and test of your library, 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 library with examples contained in examples/, with
npm start
- Create the documentation and read it with
npm run doc:open
- Integrate your library with Travis CI, using .travis.yml
- Publish your library on NPM
You can find all commands for develop, maintain and publish your library on CONTRIBUTING file.
- Webpack
- Typescript
- Babel
- JSDoc
- Minami JSDoc Template
- TSlint
- AirBnb Styleguide
- Jest
- Coveralls
- Travis CI
- Jenkins configuration