Skip to content

Quick Start

Preparation

  1. Install command-line tools
bash
$ pnpm add -g tsx@latest
$ pnpm add -g vona-cli@latest
  1. 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
bash
$ vona :create:project projectName
$ cd projectName
  1. Modify .env file

env/.env:

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

# redis
REDIS_DEFAULT_PASSWORD =
  1. Start Dev Server
bash
$ npm run dev
  1. Unit test
bash
$ npm run test
  1. Build
bash
$ npm run build

Docker Compose

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

Released under the MIT License.