Getting Started

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

Try in codesandbox

#Using tool

You can create zely application easily with create-zely.

1. Download the template using the create-zely tool:

$ npx create-zely
 
? Project name: my-app
? Directory: my-app
? Use Typescript: Yes
? Use Export Default: Yes
 
Cloning Templates...
 
  $ cd my-app
  $ npm i
  $ npm run dev
 
Happy Hacking!

2. Install Dependencies:

$ npm install

3. Run the app:

$ npm dev # start app

#Manual Installation

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

Enter the command below:

$ npm install --save-dev zely

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

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

reference: config references