Skip to content

Getting Started

Try it!

Using tool

You can create zely application easily with create-zely.


  1. Download Template
bash
$ npx create-zely

? Project name: my-app
? Directory: my-app
? Template: javascript
$ npx create-zely

? Project name: my-app
? Directory: my-app
? Template: javascript
bash
$ yarn create zely

? Project name: my-app
? Directory: my-app
? Template: javascript
$ yarn create zely

? Project name: my-app
? Directory: my-app
? Template: javascript
  1. Install Dependencies
bash
$ npm install
$ npm install
bash
$ yarn
$ yarn
  1. Run!
bash
$ npm dev # start app
$ npm dev # start app
bash
$ yarn dev # start app
$ yarn dev # start app

Manual Installation

You can also add zely to a project that already exists.

Enter the command below:

bash
$ npm install --save-dev zely
$ npm install --save-dev zely
bash
$ yarn add -D zely
$ yarn add -D zely

Add the configuration file (zely.config.ts).

ts
import { defineConfig } from 'zely/config';

export default defineConfig({
  // options
});
import { defineConfig } from 'zely/config';

export default defineConfig({
  // options
});

TIP

reference: config references