Installation

Glameow is available as an npm package.

npm install glameow -g

Usage as command

# generate component and page
glameow generate

# generate component
glameow generate component

# generate page
glameow generate page

# help
glameow generate --help

# or skip installation and use via npx

# usage options
-p, --filepath                  File path url for component or page
-d, --destination               Destination path url
-o, --overwrite                 Overwrite existing files or default is false
-c, --cwd                       Set base working directory or default to 'process.cwd()'
-w, --watch                     Watch for file changes and update component/page instantaneously
-sr, --skipRegister             Skip writing to globally registered components or default is false
-h, --help                      Output usage information

Example Component

Component is a reusable block which can compose of multiple nested container or component blocks.

{
    "node": "component",
    "element": "button",
    "content": "Generated Button",
    "properties": {
        "style": {
            "height": "60px",
            "width": "200px",
            "backgroundColor": "blue"
        }
    }
}

Example Page

Page is a template block which composes of multiple container or component blocks.

{
    "node": "page",
    "element": "div",
    "meta": {
        "title": "Home",
        "description": "This is the meta description for the home page"
    },
    "data": {
        "inputValue": "Hello World"
    },
    "children": [
        {
            "node": "container",
            "element": "div",
            "children": [
                {
                    "node": "component",
                    "element": "input",
                    "properties": {
                        "placeholder": "Please input",
                        "v-model": "inputValue"
                    }
                }
            ]
        }
    ]
}

Demo

Please refer the demo repository for sample config within .glameow directory. DEMO site created by glameow.

Contributing

We'd greatly appreciate any contribution you make. :D

License

This project is licensed under the terms of the MIT license.