Kvell.js

Kvell.js

  • Docs
  • Database Plugins
  • Github

›Getting Started

Getting Started

  • Introduction
  • Install
  • kvell.config.js
  • kvell-plugins.js
  • Available Scripts
  • Packages Used In Kvell
  • API

Guide

  • Folder Structure
  • Global
  • Routes and Controllers
  • Models
  • Api Documentation
  • Logging in Kvell
  • Using Custom Ports in Development
  • Debugging in Kvell

Auto-Templating

  • Overview
  • Using generation scripts
  • Using kvell.config.js
Edit

Install

Creating an application

To setup a kvell application, you just need to run the following command

npx create-kvell-app example-app

create an application

Note: npx comes with npm 5.2+ and higher. If you use npm 5.1 or earlier, you need to install create-kvell-app globally instead:

npm i -g create-kvell-app

Once installed, you can create a kvell application by running:

create-kvell-app example-app

Running the server

Now, you can change your directory to example-app and run the application in development mode by running:

cd example-app
npm start

That's it! This will start your server on http://localhost:5001.

starting the server

Disable watch mode

The server will by default start with watch mode enabled, i.e, it will restart the server everytime you make a change in a file. To run the server without watch mode, run the server like so,

npm start -- --no-watch

Optional Installation Method

You can also create an application using the npm init script.

npm init kvell-app example-app
Last updated on 7/16/2020 by Neeraj Sharma
← Introductionkvell.config.js →
  • Creating an application
  • Running the server
    • Disable watch mode
  • Optional Installation Method
Kvell.js
Docs
Getting StartedGuidesDatabase Plugins
Social
kvell
Follow @nsharma1396
Copyright © 2020 Neeraj Sharma.