https://github.com/animatedcreativity/node-keepalive
Keep a node project (example: Glitch) always alive.
https://github.com/animatedcreativity/node-keepalive
Last synced: 4 months ago
JSON representation
Keep a node project (example: Glitch) always alive.
- Host: GitHub
- URL: https://github.com/animatedcreativity/node-keepalive
- Owner: animatedcreativity
- License: mit
- Created: 2019-01-22T11:10:31.000Z (over 7 years ago)
- Default Branch: glitch
- Last Pushed: 2019-01-22T11:25:31.000Z (over 7 years ago)
- Last Synced: 2025-10-08T15:25:14.239Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-keepalive
Keep a node project (example: Glitch) always alive.
-------------------------------------------------------
**Note:**
Works for Glitch by default. But, link can be changed to make it work for other projects too.
-------------------------------------------------------
**Usage:**
```
var keepAlive = require("node-keepalive");
keepAlive(config, expressApp);
```
config (Everything is optional):
- link: "https://" + process.env.PROJECT_DOMAIN + ".glitch.me", // project link
- endpoint: "/keepalive" // dummy endpoint to keep calling to keep the project alive.
- time: 2 // call endpoint every 2 minutes
- consoleLog: true // show log in console
- kickStart: true // if true will call endpoint right away without waiting for set time.
- callback: function(error, response, body) {} // callback function when endpoint is called
expressApp:
- An express app variable. Providing app is necessary to avoid conflict of listening ports. If app is not provided then its assumed that no other express app is listening and a new one is created to listen at default port.
--------------------------------------------------
**Example (without providing express app):**
```
var keepAlive = require("node-keepalive");
keepAlive();
```
**Example (with existing express app):**
```
var express = require('express');
var app = express();
var keepAlive = require("node-keepalive");
keepAlive({}, app);
// ....... other endpoints
var listener = app.listen(process.env.PORT, function() {
console.log('Your app is listening on port ' + listener.address().port);
});
```
**Example (with config):** Everything is optional.
```
var keepAlive = require("node-keepalive");
keepAlive({
link: "https://" + process.env.PROJECT_DOMAIN + ".glitch.me", // project link
endpoint: "/keepalive",
time: 2, // 2 minutes
consoleLog: true,
kickStart: true,
callback: function(error, response, body) {
console.log(error, response, body);
}
});
```