RESTful API Node-Express Server Boilerplate

Manual Installation

Clone the repo:

git clone https://github.com/Md-shefat-masum/node-express-complete-boilerplate.git
cd node-express-complete-boilerplate

Install the dependencies:

npm install

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Commands

Running locally:

npm dev

Running in production:

npm start

Compiling to JS from TS

npm compile

Compiling to JS from TS in watch mode

npm compile:watch

Commiting changes

npm commit

Testing:

# run all tests
npm test

# run TypeScript tests
npm test:ts

# run JS tests
npm test:js

# run all tests in watch mode
npm test:watch

# run test coverage
npm coverage

Project Structure

├── app                     # The app directory contains the core code of your application
│   ├── exceptions                          
│   ├── http    
|   |   ├── controllers                        
|   |   └── middleware                        
│   ├── mail                     
│   └── models                      
├── boostrap                          
├── config              
├── database 
|   ├── factories                     
│   └── seeders                              
├── public 
|   ├── contents                     
|   ├── css                     
|   ├── js                           
│   └── uploads                              
├── resource 
|   ├── js                     
|   ├── scss                         
│   └── views                              
├── routes 
|   ├── api                           
│   └── web                              
├── storage                           
│   └── logs                              
└── tests