Quickstart

Prerequisites

1. Check Node version

Verify that your Node version matches .nvmrc. If it doesn't, use NVM to switch to the correct version.

2. Install NPM

npm i

3. Copy Env file to local

cp .env.example .env

Startup Project

npm run dev

Or use custom CLI:

npm run dev:adv

Run TypeScript Type Checking

Run type checking for the entire project

npm run type-check

Run ESLint Check And Formatting

npm run lint:eslint-fix

Developerment Tools

IDE

We recommend using VSCode for development

Extensions

We recommend these VSCode extensions to enhance your development workflow and experience:

• Vue - Official - Visual Studio Marketplace
• ESLint - Visual Studio Marketplace
• Code Spell Checker - Visual Studio Marketplace
• es6-string-html - Visual Studio Marketplace
• XState VSCode - Visual Studio Marketplace

For a complete list of recommended VSCode extensions, check .vscode/extensions.json