Create Node Base

Introducing "Create Node Base" – Kickstart Your Node Projects with Ease and Efficiency

'Create Node Base' is a comprehensive and robust starting point for Node.js applications. Designed to streamline development, this boilerplate comes equipped with essential tools and best practices, allowing you to focus on building your application's core features rather than setting up the basics.

Click here to give any suggestions or report an issue

NOTE: This package will be updated more as the time progress.

Table of Contents

• Create Node Base
  • Table of Contents
  • Getting started
    • Installation
    • To setup new Node project
  • Folder structure
  • Nodebase Cli
  • To install cli
  • Available Cli commands
    • Create Controller
    • Create Model
    • Create Mail
    • Create Middleware

Getting started

Installation

npm i -g create-nodebase

To setup new Node project

npx create-nodebase <project-name>

npx create-nodebase my-app

Node version >=20.0.0 satisfied. Current version: v20.13.1.

Starting CLI...

? Enter Project name: » my-project

√ Enter Project name: ... my-project

? Select Database type: » - Use arrow-keys. Return to submit.
>   MySQL
    MariaDB
    Postgres
    SQL Server
    Oracle

√ Select Database type: » MySQL

Sit back and relax while the project is being created...

Creating project directory...

Project directory created.

Creating project files...

Project created successfully!

To get started:

  cd my-project

  npm install

Note:
  Your project comes with mail and database support.
  Set up your mail and database credentials in .env file.
  Then run 'npm start' to start the development server.

  npm start
    

Folder structure

• my-project
  • app
    • controller
    • mail
    • model
    • middleware
  • config
  • lang
  • routes
  • storage
  • utils
  • views
  • i18n.js
  • .env.example
  • .env
  • index.js
  • package.json

Nodebase Cli

We have developed a cli for the create-nodebase which helps you to create industry standard code structure

To install cli

npm i -g nodebasecli

Available Cli commands

This package comes with cli commands to create controller, model, middleware and mail

Create Controller

This cli command will create controller

nodebase make:controller UserController

Create Model

This cli command will create model

nodebase make:model UserDetail

Create Mail

This cli command will create mail

nodebase make:mail OrderMail

Create Middleware

This cli command will create middleware

nodebase make:middleware KeyValidateMiddleware