create-vui-app v0.5.0

Create VUI App

The easiest way to get started with VUI is by using create-vui-app. This CLI tool enables you to quickly start building a new VUI application, with ALMOST everything set up for you. Indeed, you will still need to set up your NPM auth token which is required to install @veracity org packages.

To get started, use the following command:

npx create-vui-app@latest
# or
yarn create vui-app
# or
pnpm create vui-app

To directly create a new app in a specific folder, you can send a name as an argument. For example, the following command will create a new VUI app called internal-app in a folder with the same name:

npx create-vui-app@latest internal-app
# or
yarn create vui-app internal-app
# or
pnpm create vui-app internal-app

Options

create-vui-app comes with the following options:

• -t, --template name - An example to bootstrap the app with.
• --use-npm - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run yarn create vui-app.
• --use-pnpm - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using pnpm we recommend running pnpm create vui-app.
• --use-yarn - Explicitly tell the CLI to bootstrap the app using yarn. To bootstrap using pnpm we recommend running yarn create vui-app.

Why use Create VUI App?

create-vui-app allows you to create a new VUI app within seconds. It is officially developed by the maintainers of VUI, and includes a number of benefits:

• Interactive experience: Running npx create-vui-app (with no arguments) launches an interactive experience that guides you through setting up a project.
• Support for templates: Create VUI App can bootstrap your application using different templates (e.g. npx create-vui-app --template complex-dashboard). (TODO)