@21epub/create-parcel-app

CLI for easily bootstrapping node cli app in Typescript.

Usage no npm install needed!

<script type="module">
  import 21epubCreateParcelApp from 'https://cdn.skypack.dev/@21epub/create-parcel-app';
</script>

README

create-parcel-app

CLI for creating node CLI app with Typescript support .

NPM Build Status JavaScript Style Guide

Intro

Easy to create a parcel ts app (parcel 1.x) .

Parcel app for several scenario :

  • Tiny app
  • Demo for test
  • Medium deployment (no complex data logic )
  • A single app solution for some project

Easy to Release and Publish your CLI app .

Features

  • Easy-to-use CLI
  • Handles all modern JS features
  • Babel for transpiling
  • Jest + testing-library for testing.
  • TypeScript Only
  • Sourcemap creation
  • lint-staged support
  • Conventional commit by git-cz
  • Format on Save ( Vscode Editor )
  • Travis CI & Code coverage by custom configuration

Install globally

This package requires node >= 10.

npm install -g @21epub/create-parcel-app

Usage with npx ( Recommended )

No need to create an empty folder before running.

npx @21epub/create-parcel-app

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Creating a New CLI APP

create-parcel-app

Answer some basic prompts about your app, and then the CLI will perform the following steps:

  • copy over the template
  • install dependencies via yarn or npm
  • initialize local git repo

At this point, your new app is ready and is all setup for local development.

Development

Now, anytime you can keep on developing

npm start # start bundle and watch your dev code

For Proxy Server Development Before start , customize your proxy api in scripts/proxy.config.json

npm run start:proxy

Commit Method Recommandation

npm run commit # lint before commit can save your time , and then conventional commit with git-cz

Test

npm test

This builds commonjs of your module to dist/ and then publishes your module to npm.

License

MIT © 21epub