Skip to content

Latest commit

 

History

History
99 lines (59 loc) · 4.08 KB

commands.md

File metadata and controls

99 lines (59 loc) · 4.08 KB
Raw

kyt command line interface

kyt includes a CLI with all the commands needed for development.

kyt setup includes these commands as scripts in your package.json:

yarn dev

Or you can run a command with yarn kyt {command}, e.g.:

yarn kyt build
  • dev starts up a development environment
  • build compiles server and client code for production use
  • setup is a tool for creating new kyt projects. It installs starter-kyts and all the tools you need to begin development.
  • list provides information about available starter-kyts
  • --help shows commands and their documentation

dev

The dev command takes the entry index.js in src/client/ and src/server/, compiles them, and starts client and backend servers. The dev environment includes hot-reloading to allow for fast development.

If hasServer is set to false in kyt.config.js, src/server/ is ignored and no backend server is started.

If hasClient is set to false in kyt.config.js, src/client/ is ignored and no client server is started.

Optionally, you can configure urls for the development servers in the kyt config.

You can pass flags to the node server through kyt dev. For example:

kyt dev -- --inspect

will run the node debugging for Chrome DevTools

build

The build command takes the entry index.js in src/client/ and src/server/ (ignoring the latter if hasServer set to false in kyt.config.js), compiles them, and saves them to a build folder. This is an optimized production build.

The build command will also copy the src/public directory for static assets.

build uses option -C(--config) to denote a path to a different kyt.config.js file

setup

The setup command sets up your project with all the application files that you'll need to use kyt, based on a starter-kyt.

If kyt finds any files with duplicate names, it will back up your file before replacing it.

kyt setup will take you through the process of setting up a new kyt project with a set of interactive questions. If you wish to automate this process you can use these optional flags:

  • -d The name of the new project directory. If not specified kyt will install the project in your current working directory.
  • -r The Github url for a starter-kyt. If not specified you will be prompted to select a starter-kyt from the supported list.
  • -p The package manager to use, either npm or yarn. If not specified, defaults to yarn if it's installed globally, otherwise npm will be used.

kyt will provide you with a list of supported starter-kyts to install. The natively supported starter-kyts are:

list

The list command lists the supported starter-kyts. It includes:

  • A description of best use cases
  • Installation instructions

kyt list

Setup a new project

yarn kyt setup

Universal React starter-kyt

This default starter-kyt is a good base for building advanced, universal React apps.

Select universal when prompted to choose a starter-kyt

Static starter-kyt

Generate a static site that does not require an application server. Useful when you want to host a site as a collection of files in a CDN.

Select static when prompted to choose a starter-kyt

Server starter-kyt

This starter-kyt is configured with a src/client directory and is intended to be used by applications that only run on Node with no client scripts. Useful for multi-page apps without a lot of interactivity.

Select server when prompted to choose a starter-kyt