https://github.com/ruffiano/express-boilerplate-server
A Kickstarter project for quickly building RESTful APIs using Node.js, Express, Mongoose, NginX and Docker.
https://github.com/ruffiano/express-boilerplate-server
api boilerplate-template docker docker-compose express-js load-balancer nginx nginx-docker nodejs-server
Last synced: 3 months ago
JSON representation
A Kickstarter project for quickly building RESTful APIs using Node.js, Express, Mongoose, NginX and Docker.
- Host: GitHub
- URL: https://github.com/ruffiano/express-boilerplate-server
- Owner: Ruffiano
- Created: 2021-10-09T12:50:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-12T13:08:25.000Z (over 4 years ago)
- Last Synced: 2024-10-18T18:20:51.807Z (over 1 year ago)
- Topics: api, boilerplate-template, docker, docker-compose, express-js, load-balancer, nginx, nginx-docker, nodejs-server
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```bash
git clone https://github.com/Ruffiano/express-boilerplate-server.git
```
### :wrench: Installation
| Install |
| :------: |
| `npm install`|
### :electric_plug: 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:
```bash
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](https://swagger.io/) 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.
```bash
sudo apt-get update
sudo apt install nginx
```
- Next, open the file
```bash
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
```bash
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.
```bash
sudo systemctl restart nginx
```
- If Nginx doesn’t automatically start for some reason, the command to start it is:
```bash
sudo systemctl start nginx
```
- Now it’s time to start our project
```bash
npm run start && npm run worker
```
## Other Projects by Topic:
1. [algorithms-and-data-structures](https://github.com/Ruffiano/algorithms-and-data-structures) - Data sturcture and algorithm.
2. [loadbalancer.worker.server](https://github.com/Ruffiano/loadbalancer-worker-server) - Load Balancing and workers NodeJs apps using Nginx.
3. [crash-reporter-server](https://github.com/Ruffiano/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](CONTRIBUTING.md).
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](LICENSE)