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

  • Pre-installed Packages

  • Pre-installed Dev Packages

  • Node Simplify

    • To Install

    • Node Simplify Documentation

  • Nodebase Cli

    • To install cli

    • Nodebase Cli Documentation

  • Contribute

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
    
You can also install cli support with:

  npm i -g nodebasecli

Here is the documentation:

	https://www.npmjs.com/package/nodebasecli

Folder structure

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

Pre-installed Packages

• bcrypt: A library to help you hash passwords.
• cors: CORS is a node.js package for providing a Connect/middleware that can be used to enable CORS with various options.
• dotenv: Dotenv is a zero-dependency module that loads environment variables from a .env
• events: Node's event emitter for all engines.
• express-handlebars: A Handlebars view engine for Express
• i18next: i18next is a translation library
• jsonwebtoken: JWT Token manager
• joi: The most powerful schema description language and data validator for JavaScript.
• nodemailer: end emails from Node.js – easy as cake!
• sequelize: Sequelize is an easy-to-use and promise-based Node.js ORM tool for Postgres, MySQL, MariaDB, SQLite, DB2, Microsoft SQL Server, and Snowflake.
• node-simplify: Node Simplify is a versatile npm package designed to empower developers by simplifying complex tasks and enhancing productivity.

Pre-installed Dev Packages

• eslint: ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
• nodemon: nodemon is a tool that helps develop Node.js based applications by automatically restarting the node application when file changes in the directory are detected.
• debug: A tiny JavaScript debugging utility modelled after Node.js core's debugging technique. Works in Node.js and web browsers.

Node Simplify

Node Simplify is a versatile npm package designed to empower developers by simplifying complex tasks and enhancing productivity.

To Install

npm i node-simplify

Node Simplify Documentation

Check the Documentation here!

Nodebase Cli

This is a package developed to helps you to create industry standard code structure

To install cli

npm i -g nodebasecli

Nodebase Cli Documentation

Check the Documentation to get you started!

Contribute

Show your ❤️ and support by giving a ⭐. Any suggestions are welcome!

Click on Sponsor me to support this package