https://github.com/l-hammer/ydt-cli

🛠️CLI for rapid Vue/jQuery development mini project.
https://github.com/l-hammer/ydt-cli

cli template-project ydtemplate

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/l-hammer/ydt-cli
• Owner: l-hammer
• License: mit
• Created: 2018-05-04T03:12:04.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-19T09:41:37.000Z (about 8 years ago)
• Last Synced: 2025-03-28T00:51:18.129Z (over 1 year ago)
• Topics: cli, template-project, ydtemplate
• Language: JavaScript
• Homepage:
• Size: 863 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    

    


        

        

        

        

    

    


        A simple CLI for scaffolding YDTemplate projects.

        


    


## Installation

Prerequisites: Node.js (>=8.x, 10.x preferred), npm version 5+ and [Git](https://git-scm.com/).

```bash

$ npm install -g ydt-cli

```

## Usage

```bash

$ ydt -h

$ ydt list

$ ydt init -h

$ ydt init  

$ ydt init   --offline

```



#### Example:

```bash

$ ydt list

```

list available official templates



```bash

$ ydt init YDTemplate my-project

```

The above command pulls the template from [l-hammer/YDTemplate](https://github.com/l-hammer/YDTemplate), prompts for some information, and generates the project at `./my-project/`.



```bash

$ ydt init YDTemplate my-project --offline

```

The above command pulls the template from local cached template([$HOME](https://www.npmjs.com/package/user-home)/.YDTemplates/YDTemplate), prompts for some information, and generates the project at `./my-project/`.



## Templates

> * [YDTemplate](https://github.com/l-hammer/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:

```bash

$ ydt init username/ 

```

## Local Templates

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

```bash

$ ydt init ~/path/ 

```

## Contributing ![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?longCache=true&style=flat-square)

- :fork_and_knife:Fork it!

- :twisted_rightwards_arrows:Create your branch: `git checkout -b my-new-feature`

- :wrench:Make your changes

- :memo:Commit your changes: `git commit -am 'Add some feature'`

- :rocket:Push to the branch: `git push origin my-new-feature`

- :tada:Submit a pull request

or submit an [issue](https://github.com/l-hammer/You-need-to-know-css/issues) - any helpful suggestions are welcomed. :stuck_out_tongue_winking_eye:

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fl-hammer%2FYDT-cli.svg?type=small)](https://app.fossa.io/projects/git%2Bgithub.com%2Fl-hammer%2FYDT-cli?ref=badge_small)

[MIT](https://github.com/l-hammer/You-need-to-know-css/blob/master/LICENSE) © 2018 LHammer