# Generator-kyma [![NPM version][npm-image]][npm-url] 
> Kyma application template (experimental)
>
## Installation

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

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

Then generate your new project:

```bash
yo kyma
```

## The generated project contain the following files:

- `k8s` folder - k8s resources
  - `app` folder  - Application code
  - `api.yaml` - API Exposure
  - `servicebindings.yaml` - Service binding and usage crd
  - `deployment.yaml` - Main deployment
  - `Dockerfile` - Application docker image
 - `Makefile` - Contain the following targets:
   - `build` - Build docker image
   - `push` - Push Docker image
   - `update-deployment` - After the docker image has pushed to the registry use this target to 
      update the deployment image 
   - `deploy` - Run build, push and update-deployment targets
 - `Dockerfile` - Suitable docker file according to the project generation technologies (node/golang/python)     
  
[npm-image]: https://badge.fury.io/js/generator-kyma.svg
[npm-url]: https://npmjs.org/package/generator-kyma