flores-create
v1.0.0-beta.0
Published
The CLI tool for creating a new Flores website.
Downloads
4
Readme
Flores Create
The CLI tool for creating a new Flores website.
Documentation
The API documentation and the guide on how to get started are available on Flores repository.
Installation
$ npm install --global flores-create
Usage
$ flores --help
Usage
$ flores-create <path> [--starter] [--package-manager]
- path: The path where you want to create the Flores website.
Options
--starter, -s: The URL of Flores starter template to download.
If not providied, it will use the default Flores starter template at:
"https://github.com/risan/flores-starter/archive/master.zip".
If it's a Github repository and you want to use the master branch, you
may provide a shorter value: "@risan/flores-starter". Note that you must
add "@" character in the front.
--package-manager, -p: The package manager to use ("npm" or "yarn").
Examples
$ flores-create my-blog
$ flores-create my-blog --starter https://github.com/risan/flores-starter/archive/master.zip
$ flores-create my-blog -s @risan/flores-starter
$ flores-create my-blog --package-manager npm
$ flores-create my-blog -p yarn
Related
- flores: Flores programmatic API.
- flores-cli: The CLI tool for Flores API.
- flores-starter: The starter template for Flores website.