Skip to content

🛠️CLI for rapid Vue/jQuery development mini project.

License

Notifications You must be signed in to change notification settings

l-hammer/YDT-cli

Repository files navigation

A simple CLI for scaffolding YDTemplate projects.

Installation

Prerequisites: Node.js (>=8.x, 10.x preferred), npm version 5+ and Git.

$ npm install -g ydt-cli

Usage

$ ydt -h
$ ydt list
$ ydt init -h
$ ydt init <template-name> <project-name>
$ ydt init <template-name> <project-name> --offline

Example:

$ ydt list

list available official templates

$ ydt init YDTemplate my-project

The above command pulls the template from l-hammer/YDTemplate, prompts for some information, and generates the project at ./my-project/.

$ ydt init YDTemplate my-project --offline

The above command pulls the template from local cached template($HOME/.YDTemplates/YDTemplate), prompts for some information, and generates the project at ./my-project/.

Templates

  • YDTemplate - A Flexible Template of Parcel + Vue/jQuery + Hot-reload + Node proxy/Mock data.

Custom Templates

It's unlikely to make everyone happy with the official templates. You can simply fork an unofficial template and then use it via ydt-cli with:

$ ydt init username/<custom template> <project-name>

Local Templates

Instead of a GitHub repo, you can also use a template on your local file system:

$ ydt init ~/path/<custom template> <project-name>

Contributing PRs

  • 🍴Fork it!
  • 🔀Create your branch: git checkout -b my-new-feature
  • 🔧Make your changes
  • 📝Commit your changes: git commit -am 'Add some feature'
  • 🚀Push to the branch: git push origin my-new-feature
  • 🎉Submit a pull request

or submit an issue - any helpful suggestions are welcomed. 😜

License

FOSSA Status

MIT © 2018 LHammer