create-backend-boilerplate v1.1.1

Node.js Express MySQL REST API Template

A project template for building REST APIs using Node.js, Express, and MySQL. This template provides a well-structured folder layout, enabling you to quickly set up a robust backend system with ease. Ideal for starting new projects with minimal setup.

Table of Contents

• Overview
• Features
• Installation
• Folder Structure
• Environment Variables
• API Endpoints
• Contributing
• License -->

Overview

This project serves as a boilerplate for creating REST APIs with a clear and scalable architecture. It includes support for:

• Express for routing
• MySQL for database management
• Environment-based configurations
• Error handling and validation
• Authentication and authorization (optional)
• Clean code structure for scalability

Features

• 📦 Modular Folder Structure
• 🔧 CRUD APIs with MySQL
• 🛡️ Authentication & Authorization (using JWT)
• 📂 Environment Configuration (dotenv)
• 📊 MySQL Database Integration
• 🛠️ Error Handling & Logging
• 🚀 Easy Deployment

Installation

Follow these steps to set up the project:

Prerequisites

• Node.js (v14.x or higher)
• MySQL (v8.x or higher)
• Git

Steps

1. Run below command to install package globally

   npm install -g create-backend-boilerplate

2. Now run below command anywhere you want to create your backend project

   create-backend-boilerplate "Your-project-name"