open-index/open-npm huggingface dataset:
npm package: @skafld/generator-skafld
Description: skafld: Scaffolding tool for modern cloud native applications
Author: skafld
Latest version: 1.6.2

# generator-skafld
![Yeoman](./images/yeoman.png)

`Skafld is a Yeoman generator for Cloud Native projects.
New generators are being added all the time, so check back often!`

## Installation

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

```bash
npm i -g yo
npm i -g @skafld/generator-skafld@latest
```

## Usage
To generate your new Spring Boot project, create a new directory and run yo:

### Java
```bash
mkdir my-fantastic-project && cd ./my-fantastic-project
touch infra/kubernetes/config/local/sample/sample-api/secrets.env

# generate
yo @skafld/skafld
```

![Generator](https://github.com/skafld/skafld-generator/assets/292542/b31bd862-90f4-48b2-9eb2-f0e675efe4a2)


### Kubernetes
To generate kubernetes manifests for an existing project:

```bash
# Navigate to the project
cd ./my-fantastic-project

# generate manifests
yo @skafld/skafld:kubernetes
```

### Terraform
To generate terraform manifests for an existing project:

```bash
# Navigate to the project
cd ./my-fantastic-project

# generate terraform
yo @skafld/skafld:terraform
```

### Github Actions
To generate Github Actions for an existing project:

```bash
# Navigate to the project
cd ./my-fantastic-project

# generate actions
yo @skafld/skafld:actions
```

### Additional Spring Boot modules
```bash
# Navigate to the project
cd ./my-fantastic-project

# generate
#yo @skafld/skafld:<module type> --name <module name>
yo @skafld/skafld:api --name my-additional-api
```