Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fadhlaouir/express-node-starter

A boilerplate for building production-ready RESTful APIs using Node.js, Express, and Mongoose
https://github.com/fadhlaouir/express-node-starter

authentication boilerplate express jwt mongodb multer node-express node-express-boilerplate node-express-mongodb nodejs nodemailer rest-api starter

Last synced: 2 months ago
JSON representation

A boilerplate for building production-ready RESTful APIs using Node.js, Express, and Mongoose

Host: GitHub
URL: https://github.com/fadhlaouir/express-node-starter
Owner: fadhlaouir
License: mit
Created: 2022-07-25T11:41:40.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-04-01T08:38:16.000Z (10 months ago)
Last Synced: 2024-11-07T10:17:26.063Z (3 months ago)
Topics: authentication, boilerplate, express, jwt, mongodb, multer, node-express, node-express-boilerplate, node-express-mongodb, nodejs, nodemailer, rest-api, starter
Language: JavaScript
Homepage:
Size: 757 KB
Stars: 9
Watchers: 2
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# REST API Developed with Node.js, Express, MongoDB, Multer and nodemailer Boilerplate

[![Author](http://img.shields.io/badge/[email protected])](https://tn.linkedin.com/in/fadhlaouiraed)
[![GitHub license](https://img.shields.io/github/license/maitraysuthar/rest-api-nodejs-mongodb.svg)](https://github.com/fadhlaouir/express-node-starter/blob/main/LICENSE)
[![Downloads](https://img.shields.io/npm/dt/express-node-starter.svg)](https://www.npmjs.com/package/express-node-starter)

## Overview

This project provides a robust API skeleton written in JavaScript ES6, suitable for any project. It offers features such as authentication, authorization, JWT tokens, role management, CRUD operations, email notifications, and more. Additionally, it automates the generation of CRUD (Create, Read, Update, Delete) operations for entities within a MongoDB database, streamlining the development process for Node.js applications built on top of Express.js.

## Table of Contents

- [Getting Started](#getting-started)
- [Features](#features)
- [Software Requirements](#software-requirements)
- [Engines](#engines)
- [How to Install](#how-to-install)
- [Setting up Environments](#setting-up-environments)
- [Project Structure](#project-structure)
- [How to Run](#how-to-run)
- [CLI Commands](#cli-commands)
- [Linting and Formatting](#linting-and-formatting)
- [Bugs or Improvements](#bugs-or-improvements)
- [License](#license)
- [Credits](#credits)
- [Support](#support)

## Getting started

This is a basic API skeleton written in JavaScript ES6.

This project will run on **NodeJs** using **MongoDB** as database.

API Documentation [Swagger]

## Features

- Authentication and Authorization
- JWT Tokens, make requests with a token after login with `Authorization` header with value `Bearer yourToken` where `yourToken` will be returned in the Login response.
- Role Manage
- Update Profile/Password User Account
- Upload Image with multer
- Reset Password Mail using `nodemailer`
- Pre-defined response structures with proper status codes.
- Included CORS.
- System notification with Firebase
- Email Template and settings
- Validations added.
- Included API collection for Postman.
- Light-weight project.
- Linting with [Eslint](https://eslint.org/). (Airbnb style)
- Included CLI for generating CRUD operations.
- husky for pre-commit hooks and lint-staged for running linters on git staged files.

## Software Requirements

- Node.js **16+**
- MongoDB **4+**

### Engines

- node **>=14.16.0 <=20.11.0**
- npm **>=6.14.11 <=10.2.4**

## How to install

### Using Git (recommended)

1. Clone the project from github.

```bash
git clone https://github.com/fadhlaouir/express-node-starter.git
```

### Using manual download ZIP

1. Download repository
2. Uncompress to your desired directory

### Install npm dependencies after installing (Git or manual download)

```bash
cd express-node-starter
npm install
```

## Setting up environments

1. You will find a file named `.env.example` on root directory of project.
2. Create a new file by copying and pasting the file and then renaming it to just `.env`
```bash
cp .env.example .env
```
3. The file `.env` is already ignored, so you never commit your credentials.
4. Change the values of the file to your environment. Helpful comments added to `.env.example` file to understand the constants.

## Project structure

```sh
.
├── .husky
│ ├── _
│ │ ├── .gitignore
│ │ └── husky.sh
│ ├── pre-commit
│ └── pre-push
├── cli
│ ├── _
│ │ ├── deleteCrud.js
│ │ ├── generateEmptyCrud.js
│ │ ├── generateMinimalCrud.js
│ │ └── helpers.js
│ ├── index.js
│ └── README.md
├── src
│ ├── controllers
│ │ ├── auth.controller.js
│ │ └── user.controller.js
│ ├── middlewares
│ │ ├── multer.js
│ │ └── verify-token.js
│ ├── models
│ │ └── user.model.js
│ ├── routes
│ │ ├── auth.route.js
│ │ └── user.route.js
│ ├── template
│ │ └── userAccountEmailTemplates.js
│ ├── utils
│ │ └── helpers.js
│ └── swagger.json
├── .commitlintrc.json
├── .editorconfig
├── .env
├── .env.example
├── .eslintignore.json
├── .eslintrc.json
├── .gitignore
├── .prettierignore.json
├── .prettierrc.json
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
└── server.js

```

## How to run

### Running API server locally

If you would like to run the API server on your local environment, you can do so by running the following command:
Windows OS

```bash
npm run develop
```

Linux OS or Mac OS

```bash
npm run develop:mac
```

```bash
Connected to the database:YOUR_DB_CONNECTION_STRING
App is running ...

Press CTRL + C to stop the process.
```

**Note:**

`YOUR_DEVELOPMENT_DB_CONNECTION_STRING` will be your MongoDB connection string for `development` environment.

`YOUR_PRODUCTION_DB_CONNECTION_STRING` will be your MongoDB connection string for `production` environment.

### Creating new models

If you need to add more models to the project just create a new file in `src/models/` and use them in the controllers.

### Creating new routes

If you need to add more routes to the project just create a new file in `src/routes/` and import it in `src/app` to be loaded.

### Creating new controllers

If you need to add more controllers to the project just create a new file in `src/controllers/` and use them in the routes.

## Using the CLI to generate CRUD operations

1. Navigate to the project directory.
2. Run the following command:

```bash
npm run crud:operation
```

See the [CLI README](cli/README.md) section for more details on how to use the CLI to generate or delete CRUD operations.

Follow the prompts to select the CRUD type (empty or minimal) and provide the entity name. The tool will generate the necessary files for the CRUD operations based on your selection.

## Linting and Formatting

### Running Eslint

```bash
npm run lint:check
```

### Fixing Eslint errors

```bash
npm run lint:fix
```

### Prettier for code formatting

```bash
npm run format:fix
```

You can set custom rules for eslint in `.eslintrc.json` file, Added at project root.

## Bugs or improvements

Every project needs improvements, Feel free to report any bugs or improvements. Pull requests are always welcome.

## License

This project is open-sourced software licensed under the MIT License. See the LICENSE file for more information.

## Credits

- Raed FADHLAOUI: [Author Email](mailto:[email protected])
- Project Repository: [GitHub Repository](https://github.com/fadhlaouir/express-node-starter)

# Sponsor on Buy Me a Coffee

If you find this project valuable, consider supporting us through Buy Me a Coffee. Your sponsorship helps us maintain and improve the project, ensuring better features, updates, and support for the community.