hellousman / nodejs-boilerplate

Boilerplate Project for building RESTful APIs and microservices using Node.js, Express and MySql.

Nodejs-Boilerplate-express-es2018

[

Boilerplate Project for building RESTful APIs and microservices using Node.js, Express and MySql.

Features

Multilayer folder structure

Code with Best Practices of Nodejs and Clean Architecture focused on codebase scalability.

Scalable and easy to use web server

Use Express for requests routing and middlewares. There are some essential middlewares for web APIs already setup, like body-parser, compression, CORS and method-override.

Database integration

Sequelize, an ORM for SQL databases, is already integrated, you just have to set the authentication configurations.

It's also setup with ESLint to make it easy to ensure a code styling and find code smells.

Requirements

• Node v10.8
• Npm

Getting Started

Clone the repo and make it yours:

git clone https://github.com/mrrobot09/Nodejs-boilerplate
cd Nodejs-boilerplate

Install dependencies:

npm i

Running Locally

npm start

Lint

# lint code with ESLint
npm lint

# try to fix ESLint errors
npm lint:fix

# lint and watch for changes
npm lint:watch

License

Usman Saleem