Kvell.js is a family of packages using which you can create Node.js applications with pre-defined configurations, a fixed application flow and a set of abstractions. It bootstraps the node application with a set of popularly used npm packages and provides a minimal setup environment so that the developer can focus directly on writing the essential parts of the application.
- Maintains a proper code standard.
- Abstracts out server configurations.
- Abstracts out database related configurations.
- Maintains a consistent top-level folder structure.
- Provides support for writing and viewing API documentations without any setups.
- Provides auto-template creation for routes and models.
- Does automatic git initialization (if possible) on project setup.
- Provides a very simple and basic logging mechanism.
Kvell takes inspiration from create-react-app in it's implementation and shares some similarity with create-react-app's methodology and internal flow when it comes to how it works under the hood.
To setup a kvell application, you just need to run the following command
npx create-kvell-app example-app
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-appOnce installed, you can create a kvell application by running:
create-kvell-app example-appNow, you can change your directory to example-app and run the application in development mode by running:
cd example-app
npm startThat's it! This will start your server on http://localhost:5001.
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-watchYou can also create an application using the npm init script.
npm init kvell-app example-appFor complete docs of Kvell, visit Kvell Docs