pm2-api

PM2 API

A PM2 NodeJs Process Manager API

This project provides a powerful API that deploy nodejs web services apps, through child_process tools. You will have a rest API application to call resources and do it dynamically.

Requirements:

• Nodejs >= 14.*
• npm >= 6.*
• pm2 >= 5.* - Install globally: npm install pm2@latest -g

Start Local:

npm run start:dev

Start Prod:

npm run start

Application start at: http://localhost:7000

APIs content:
Put all your apis sources in folder src/sub-apps, then especify the main file of project in appPath of the payload to Route /up/< app-name > to start api correctly.

Api Resources:

• Start a new app:
  • POST
  • Route: http://localhost/up/< app-name >
  • Payload:

    {
      "appPath": "<my-api/main/file/app.js>",
      "mode": "cluster" // OPTIONAL - To enable the cluster mode
    }
    

• Status of all apps:
  • GET
  • Route: http://localhost/status
• Status of an apps:
  • GET
  • Route: http://localhost/status/< app-name >
• Down all apps:
  • GET
  • Route: http://localhost/down
• Down an app:
  • GET
  • Route: http://localhost/down/< app-name >

---

Repository:

• https://github.com/Ricardo-Costa/pm2-api

References:

• https://pm2.keymetrics.io/docs/usage/quick-start/
• https://nodejs.org/api/child_process.html

Credits Logo:

• https://iconfinder.com/alla.afanasenko
• https://www.iconfinder.com/icons/1931211/api_integration_interaction_communication_connection_network_it_icon