Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 1.68 KB

README.md

File metadata and controls

74 lines (51 loc) · 1.68 KB

FrappeJS CLI

A Command Line Interface for quickly building apps with FrappeJS.

Installation

npm i -g https://github.com/frappe/frappejs-cli

Usage

Create new app

Create a new FrappeJS application

Step 1:
frappe create-app app-name
Step 2:

Choose any of the following boilerplate for your new app:

  1. Blank ( Blank Frontend + Server )
  2. VueJS ( Vue.js Frontend + Server + SQLite Database )
  3. Server ( No Frontend + Server )
Step 3:

Choose a target platform for your new app:

  1. Web
  2. Electron
Step 4:

Choose a node package manager to install dependencies or skip to install dependencies later:

  1. NPM
  2. Yarn
  3. Skip this step

Create new model

Create a new FrappeJS model

frappe create-model model-name

Enter the model details as prompted. Click here to know more about models in FrappeJS.

Serve application

Serve your application in development mode either in Browser (Web) or Electron with auto-reload capabillity.

To serve in Browser

frappe start

To serve in Electron

frappe start electron

Build application

This feature is under development.