Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliranmal/vue-cli-template-registry
a solution for installing vue-cli custom templates hosted on private/enterprise repositories
https://github.com/eliranmal/vue-cli-template-registry
cli command-line-interface command-line-tool ghe github github-enterprise gitlab hosting private-repository shell terminal tooling vue vue-cli vue-cli-2x vue-cli-templates vue-js
Last synced: 20 days ago
JSON representation
a solution for installing vue-cli custom templates hosted on private/enterprise repositories
- Host: GitHub
- URL: https://github.com/eliranmal/vue-cli-template-registry
- Owner: eliranmal
- License: mit
- Created: 2019-06-02T21:29:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-21T08:43:51.000Z (over 5 years ago)
- Last Synced: 2024-11-28T18:13:49.259Z (26 days ago)
- Topics: cli, command-line-interface, command-line-tool, ghe, github, github-enterprise, gitlab, hosting, private-repository, shell, terminal, tooling, vue, vue-cli, vue-cli-2x, vue-cli-templates, vue-js
- Language: Shell
- Homepage:
- Size: 36.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-cli-template-registry
*a solution for installing vue-cli custom templates hosted on private/enterprise repositories*
[![NPM][1]][2] [![mentioned in awesome-vue][6]][7]
## overview
this is a command-line tool that enables the usage of [vue-cli custom templates][3] hosted on private/enterprise repositories \[[1][101]].
it stores the templates locally, so we can install them from a local path. for example:
```sh
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][100] section for more details.
#### via NPM
this is the most convenient choice when you're dealing with multiple custom templates.
```sh
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:
```sh
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][101]]:
```sh
curl -Lsf https://raw.github.com/eliranmal/vue-cli-template-registry/master/bin/registry.sh | bash -s install
```
:ok_hand: ***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][101]]:
```sh
vue-cli-template-registry install
```
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][4]). if/when this issue is resolved, vue-cli-template-registry will become obsolete.*
2. *make sure to replace `` with your custom template clone URL (or local path).*
[1]: https://img.shields.io/npm/v/vue-cli-template-registry.svg?style=flat-square
[2]: https://www.npmjs.com/package/vue-cli-template-registry
[3]: https://github.com/vuejs/vue-cli/tree/master#custom-templates
[4]: https://github.com/vuejs/vue-cli/issues/3384
[6]: https://awesome.re/mentioned-badge-flat.svg
[7]: https://github.com/vuejs/awesome-vue
[100]: #usage
[101]: #notes