A kickstarter for nodejs restfull API

A boilerplate/kickstarter project for quickly building RESTful APIs using Node.js, Express, Mongoose, NginX and Docker.

Overview

When I started this project, my primary focus was on simplicity and ease of use. You can downlaod this project and build your own project top of my source base.

Express server development, by runing cmd, you will get a production-ready Node.js app installed and fully configured on your machine. The app comes with many built-in features, such as authentication using JWT, request validation, unit and integration tests, nginx, docker support, API documentation, etc. For more details click on content.

Manual Installation

If you would still prefer to do the installation manually, follow these steps:

Clone the repo:

git clone https://github.com/Ruffiano/express-boilerplate-server.git

🔧 Installation

Install
npm install

🔌 Usage (from source)

Run main server manulaly:

Run Code	Test All Code	Test by Name
npm run start	npm run test	npm run test -- "testName"

Run worker manulaly:

Run Code	Test All Code	Test by Name
npm run worker	npm run woker	npm run test -- "testName"

Docker:

docker-compose up
docker-compose down

Project Structure

src\
 |--middlewares\    # Custom express middlewares
 |--models\         # Mongoose models (data layer)
 |--routes\         # Routes
 |--startup\        # Run all project dependet source
 |--test\           # Unit tests and integration tests
 |--services\       # Microservice app which is runnig with different process
 |--utils\          # Utility classes and functions
 |--index.js        # App entry point

API Documentation

To view the list of available APIs and their specifications, run the server and go to http://localhost:5000/v1/docs in your browser. This documentation page is automatically generated using the swagger definitions written as comments in the route files.

API Endpoints

List of available routes:

Routes:\

/api/v1/categories
/api/v1/customers
/api/v1/courses
/api/v1/enrollments
/api/v1/users
/api/v1/auth

NGINX Configuration for load balancer:

If you want to run project by manualy without docker image, you shoul folow configuration steps in below, otherwise just type "docker-compose up" in command line:

• Now let’s install Nginx in ubuntu.

sudo apt-get update
sudo apt install nginx

• Next, open the file

sudo nano /etc/nginx/sites-enabled/myserver.conf

• Add this configurations into .conf file

upstream workers {  
    server express.worker.1.com:5001 weight=6 max_fails=3 fail_timeout=30s;  # node 1
    server express.worker.2.com:5002 weight=4 max_fails=3 fail_timeout=30s;  # node 2
}

server {
    listen 80;
    listen [::]:80;
    server_name amazonaws.com;  
    
    location / {
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
        proxy_pass http://express.boilerplate.server.com:5000/;
        proxy_redirect off;
    }    
    location /worker {
        proxy_set_header X-Real-IP $remote_addr;  
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
        proxy_set_header Host $http_host;  
        proxy_set_header X-NginX-Proxy true;  
        proxy_pass http://workers/;  
        proxy_redirect off;  
    } 
}

• Type this comand line

sudo nginx -t 

The output upon running the above command would look like this:

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

• The above output confirms that our configuration was successful. Next, stop and restart Nginx to enable your changes. Nginx is started upon installation by default.

sudo systemctl restart nginx

• If Nginx doesn’t automatically start for some reason, the command to start it is:

sudo systemctl start nginx

• Now it’s time to start our project

npm run start && npm run worker

Other Projects by Topic:

1. algorithms-and-data-structures - Data sturcture and algorithm.
2. loadbalancer.worker.server - Load Balancing and workers NodeJs apps using Nginx.
3. crash-reporter-server - Collects any crashes (error, unhandled exceptiont, [log, info, warning]) by any application.

Contributing

Contributions are more than welcome! Please check out the contributing guide.

Coding style guide ESLint to ensure a consistent code style in the project, based on Airbnb's JS style guide. https://github.com/airbnb/javascript

License

MIT