Getting Started

In this chapter, we will introduce how to create your first zely app.

#Using tool

You can create zely application easily with create-zely.


  1. Download the template using the zely-cli tool:
Terminal
npx zely-cli init --dir my-app --template=typescript
  1. Install Dependencies:
Terminal
npm install
  1. Run the app:
Terminal
npm dev # start app

#Manual Installation

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

Enter the command below:

npm
npm install --save-dev zely

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

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