Skip to content
Vixen UI

Installation

System Requirements:

  • Node 18.12.0 or higher
  • macOS, Windows (including WSL), or Linux

Automatic Installation

We recommend starting new Vixen UI project using @vixen-js/create-vixen, which setups all things you need automatically. follow the steps below to setup an initial Vixen UI project:

Create The Project Scaffold:

Terminal window
pnpm create @vixen-js/vixen my-project #if you want to use the default_template
pnpm create @vixen-js/vixen my-project --template vanilla #if you want to use the vanilla-ts template
pnpm create @vixen-js/vixen my-project --template react #if you want to use the react template

On Installation process, you’ll see the following output:

Terminal window
Creating project: test-project with default_template
Started git initialization
Initialized empty Git repository in {PROJECT_DIR}/test-project/.git
Project created successfully!
Next steps:
	1. run 'cd test-project && pnpm i' to install dependencies
	2. Start development application running 'pnpm dev'

After the output, @vixen-js/create-vixen will create a folder with your project name with all the dependencies required to start working with Vixen UI. If you’re new to Vixen UI, check out the Tutorials section.