@docomodigital/pdor

A boilerplate to create a simple Javascript library

Usage no npm install needed!

<script type="module">
  import docomodigitalPdor from 'https://cdn.skypack.dev/@docomodigital/pdor';
</script>

README

pdor

pdor is a tool to generate a library from a given boilerplate.

Available boilerplates

Vanilla JS: generate a Vanilla js project
React Component: generate a React component
Typescript library: generate a Vanilla Ts project
Remote: pass a github repo url to use your own boilerplate

Usage

With npx (with npm 5.2+ and higher):

npx @docomodigital/pdor my-app

for older versions of npm, install the package as global first:

npm i -g @docomodigital/pdor
pdor my-app

Available Options

--yarn: use Yarn Package manager to install required dependencies instead of npm
--type: specify the boilerplate to use (vanilla, react-component, typescript or a github repo url)
--verbose: print more info during the generation process
--no-interaction: if an user input is required, stop the process. Useful for CI tools
--skip-install: skip the dependency installation step

Commands

For a list of available features of the generated boilerplate, please refer to the used boilerplate configuration.

Interested in creating a custom boilerplate? Read how