Skip to content

Latest commit

 

History

History

create-nx-ktor

create-nx-ktor

npm version github action - release semantic-release

Our very own CLI to create Nx workspaces with built-in support for Ktor!

The goal of this CLI is to ease the process of creating a Nx workspace that can host and manage Ktor projects, thanks to our @nxrocks/nx-ktor plugin, that is automatically installed within it.

Prerequisites

To run this CLI, all you need is to have NodeJS installed (preferably the current LTS version). Then to later create and run your Ktor projets, you'll need a Java Runtime as well.

  • NodeJS (preferably latest or LTS version) in path
  • JRE or JDK in path

Getting Started

Run npx create-nx-ktor your-workspace-name to execute the CLI.

This command will guide you through the creation process steps by steps.

Options

Run npx create-nx-ktor --help to print some helpful info on available options.

Compatibility with Nx

Every Nx package relies on the underlying Nx Workspace/DevKit it runs on. This table provides the compatibility matrix between major versions of Nx workspace and this package.

Package Version Nx Workspace version
>=v3.0.0 >=v17.3.0
<v3.0.0 <17.3.0

License

Copyright (c) 2023-present Tine Kondo. Licensed under the MIT License (MIT)