Quick Start

Prerequisites

Name	Version
pnpm	>=10.19.0
Nodejs	>=24.8.0
Redis	>=7.2.6
MySQL	>=8
Postgresql	>=17

• Redis: VonaJS provides the following capabilities based on Redis:
  • Queue, Schedule, Startup, Broadcast, Caching, Two-layer cache, and Redlock
• MySQL/Postgresql: Choose what you want to use

Preparation

1. Install command-line tools

$ pnpm add -g tsx@latest
$ pnpm add -g vona-cli@latest

2. Install Vscode extension: Vona - Official

This extension provides a large number of menus for quickly creating code skeletons for various resources

Quick Start

1. Create Project

$ vona :create:project projectName
$ cd projectName

WARNING

In Windows, you need to open Terminal or VSCode as an administrator

2. Modify .env file

env/.env:

# database
DATABASE_DEFAULT_CLIENT = 'pg' # pg/mysql
DATABASE_CLIENT_PG_PASSWORD =
DATABASE_CLIENT_MYSQL_PASSWORD =

# redis
REDIS_DEFAULT_PASSWORD =

WARNING

For development and test environments, it is recommended to use the system default database name so that the system can automatically create a test database

3. Start Dev Server

$ npm run dev

4. Unit test

$ npm run test

5. Build

$ npm run build

Docker Compose

$ npm run build:docker
$ sudo docker-compose build
$ sudo docker-compose up