# generator-ktor

> A command line interface to bootstrap the new Ktor project

Latest version **1.0.2** (published 2022-08-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install generator-ktor
pnpm add generator-ktor
yarn add generator-ktor
bun add generator-ktor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-08-05 |
| First published | 2022-05-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 40.2 KB |
| Known vulnerabilities | 0 (+21 in 3 direct dependencies) |
| Install scripts | no |
| Author | Ekaterina.Zaikina@jetbrains.com |
| Maintainers | kotlin |
| Keywords | yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-ktor
- npm.io page: https://npm.io/package/generator-ktor

## Dependencies (14)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [tar](https://npm.io/package/tar.md) 6.1.11
- [gauge](https://npm.io/package/gauge.md) 4.0.0
- [maven](https://npm.io/package/maven.md) 5.0.0
- [stream](https://npm.io/package/stream.md) 0.0.2
- [adm-zip](https://npm.io/package/adm-zip.md) 0.5.6
- [prettier](https://npm.io/package/prettier.md) ^2.0.5
- [text-table](https://npm.io/package/text-table.md) 0.2.0
- [loading-cli](https://npm.io/package/loading-cli.md) 1.1.0
- [cli-progress](https://npm.io/package/cli-progress.md) 3.10.0
- [cli-spinners](https://npm.io/package/cli-spinners.md) 2.6.1
- [find-java-home](https://npm.io/package/find-java-home.md) 1.2.2
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) 5.6.1
- [node-fetch-commonjs](https://npm.io/package/node-fetch-commonjs.md) 3.1.1

## Recent versions

- 1.0.2 (latest) — 2022-08-05
- 1.0.0 — 2022-05-27

## README

A Yeoman generator that brings the capability to generate server [Ktor](http://ktor.io/) applications.

## Installation
First, you need to have [Node.js](https://nodejs.org/en/) and `npm` installed.
The generator is compatible with Node.js versions above 14.0.0.

To install Yeoman globally on your system, execute the following command:
```
npm install -g yo
```

With Node.js and Yeoman installed, you can run this command to install the Ktor generator:
```
npm install -g generator-ktor
```


## Usage

To generate a new Ktor project, create a new directory and go into it:

```
mkdir ktor-sample
cd ktor-sample
```

Then, you can generate a project:

```
yo ktor
```

It will prompt you for a series of inputs such as a project name, a [build system](https://ktor.io/docs/server-dependencies.html) used for a project, a set of installed [plugins](https://ktor.io/docs/plugins.html), and so on.

Finally, you can run the generated project with the `npm start` command.

---
_Source: https://npm.io/package/generator-ktor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._