# Diamond

### Features

* 🏗 **Scaffolding**:
  * Scaffolding Vue3 + vue cli project
    * Basic structure generation
    * Addon supports
      * SVG addon
      * API addon
      * Auth addon
  * Scaffolding Vue3 + webpack project
* 🧬 **Template generator** (WIP)
  * Vue **component** template generation
  * Vue **state** template generation
    * Create initial state template
    * Create default state template
    * Adding state
    * Adding mutation
    * Adding action
  * Vue **api** template generation
    * Create initial API file
    * Create default API template
    * Adding API functions
  * Vue page template generation
* 💠 **Project Type scaffolding** (WIP)
  * Scaffolding project for admin panel
  * Scaffolding project for eshop
  * Scaffolding project for website
  * Scaffolding project for webapp
  * Scaffolding project for hybrid app

### Installation

First, install [Yeoman](http://yeoman.io) and generator-diamond using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo generator-diamond
```

Then generate your new project:

```bash
yo diamond
```

### Getting To Know Yeoman

* Yeoman has a heart of gold.
* Yeoman is a person with feelings and opinions, but is very easy to work with.
* Yeoman can be too opinionated at times but is easily convinced not to be.
* Feel free to [learn more about Yeoman](http://yeoman.io/).

### License

MIT © [TriDiamond](https://tridiamond.tech)
