Giter Club home page Giter Club logo

vue-cli-template-registry's Introduction

vue-cli-template-registry

a solution for installing vue-cli custom templates hosted on private/enterprise repositories

NPM mentioned in awesome-vue

overview

this is a command-line tool that enables the usage of vue-cli custom templates hosted on private/enterprise repositories [1].

it stores the templates locally, so we can install them from a local path. for example:

vue init ~/.vue-cli-templates/my-awesome-template my-app

setup

choose your preferred method:

none!

for a one-time installation of an arbitrary custom template, no setup is required. skip ahead to the usage section for more details.

via NPM

this is the most convenient choice when you're dealing with multiple custom templates.

npm i -g vue-cli-template-registry

manual

if you don't use NPM, or you're just into typing stuff, you can manually copy the registry script to your local bin directory:

curl -L -f -O https://raw.github.com/eliranmal/vue-cli-template-registry/master/bin/registry.sh
install -v -m 0755 ./registry.sh /usr/local/bin/vue-cli-template-registry
rm -v ./registry.sh

usage

if you chose to skip the setup, you can use a single command line to fetch and run the registry [2]:

curl -Lsf https://raw.github.com/eliranmal/vue-cli-template-registry/master/bin/registry.sh | bash -s install <awesome-cli-template>

๐Ÿ‘Œ tip: building your own custom template? add this one-liner to the readme page.

if you followed the setup, you will find the vue-cli-template-registry command available in the terminal.
it can be run with the same arguments [2]:

vue-cli-template-registry install <awesome-cli-template>

the first argument is the registry command, and can be either install, uninstall or update.
the second is for passing the custom template source, either in the form of a github clone URL, or a local path.

for more details use the -h flag.

notes

  1. at the time of writing, vue-cli does not work for such repositories (see this issue). if/when this issue is resolved, vue-cli-template-registry will become obsolete.
  2. make sure to replace <awesome-cli-template> with your custom template clone URL (or local path).

vue-cli-template-registry's People

Contributors

eliranmal avatar

Stargazers

 avatar  avatar

Watchers

 avatar  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.