Git Product home page Git Product logo

oc-vuetober-cli's Introduction

oc-vuetober-cli

A simple CLI for scaffolding Vuetober themes.

Installation

Prerequisites: Node.js and Git.

$ npm install -g oc-vuetober-cli

Usage

$ vuetober init my-project
$ cd my-project
$ npm install
$ npm run dev

The above command pulls the template from scottbedard/oc-vuetober-theme, prompts for some information, and generates the project at ./my-project/.

Official Templates

The purpose of the official Vuetober theme template is to provide an opinionated, battery-included development tooling setups so that users can get started with actual app code as fast as possible.

Custom Templates

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

vuetober init username/repo my-project

Where username/repo is the GitHub repo shorthand for your fork.

The shorthand repo notation is passed to download-git-repo so you can also use things like bitbucket:username/repo for a Bitbucket repo and username/repo#branch for tags or branches.

If you would like to download from a private repository use the --clone flag and the cli will use git clone so your SHH keys are used.

You can also create your own template from scratch:

  • A template repo must have a template directory that holds the template files.

  • All template files will be piped through Handlebars for simple templating - oc-vuetober-cli will automatically infer the prompts based on {{ }} interpolations found in the files.

  • A template repo may have a meta.json file that provides a schema for the prompts. The schema will be passed to prompt-for as options. See example.

While developing your template you can test via oc-vuetober-cli with:

vuetober init ~/fs/path/to-custom-template my-project

oc-vuetober-cli's People

Contributors

yyx990803 avatar orlandoaleman avatar scottbedard avatar zhouwenbin avatar zigomir avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.