Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kktjs/create-kkt

Creates a KKT application using the command line.
https://github.com/kktjs/create-kkt

cli create-kk create-react-app kkt kkt-cli react react-app uiw

Last synced: about 1 month ago
JSON representation

Creates a KKT application using the command line.

Awesome Lists containing this project

README

        

# create-kkt

[![Coverage Status](https://kktjs.github.io/create-kkt/badges.svg)](https://kktjs.github.io/create-kkt/lcov-report/) [![Build](https://github.com/kktjs/create-kkt/actions/workflows/ci.yml/badge.svg)](https://github.com/kktjs/create-kkt/actions) [![NPM Version](https://img.shields.io/npm/v/create-kkt.svg)](https://www.npmjs.com/package/create-kkt)

Creates a [kkt](https://github.com/kktjs/kkt) application using the command line.

### Usage

```shell
# npm 6.x
$ npm init kkt my-app --example react-component-tsx
# npm 7+, extra double-dash is needed:
$ npm init kkt my-app -- --example react-component-tsx

$ yarn create kkt [appName]
# or npm
$ npm create kkt my-app
# or npx
$ npx create-kkt my-app
```

or

```bash
$ npm i create-kkt -g
```

### Command Help

Below is a help of commands you might find useful. The example download is from https://kktjs.github.io/zip/

```bash
Usage: create-kkt [options] [--help|h]

Options:
--version, -v Show version number
--help, -h Displays help information.
--output, -o Output directory.
--example, -e Example from: https://kktjs.github.io/zip/ , default: "basic"
--force, -f Overwrite target directory if it exists. default: false
--path, -p Specify the download target git address. default: "https://kktjs.github.io/zip/"

Example:
npx create-kkt my-app
yarn create kkt appName
npm create kkt my-app
npm create kkt my-app -f
npm create kkt my-app -p https://kktjs.github.io/zip/

Copyright 2021
```

## Development

```bash
npm run watch # Listen compile .ts files.
npm run build # compile .ts files.
```

## License

[MIT © Kenny Wong](https://github.com/kktjs/kkt/blob/master/LICENSE)