basic-site-pro
v1.0.4
Published
A simple tool to generate static HTML output for keeping sites alive
Maintainers
Readme
basic-site-pro
A simple npm package that adds an uptime monitoring page to your Express application to keep it alive on hosting platforms that sleep during idle periods.
Why Use This?
Many free hosting platforms (like Heroku, Render, etc.) put your application to sleep after a period of inactivity. This package adds a lightweight uptime monitoring page that you can:
- Use to keep your site active
- Monitor the last update time
- Provide a visual confirmation that your site is running
Installation
npm install basic-site-proUsage
Add it to your Express application:
const express = require('express');
const { createUptimeMiddleware } = require('basic-site-pro');
const app = express();
// Add the uptime monitor middleware
app.use(createUptimeMiddleware(app, {
route: '/uptime', // Optional: default is /uptime
startPort: 3000, // Optional: default is 3000
maxPort: 3100 // Optional: default is 3100
}));
// Your other routes and middleware
app.get('/', (req, res) => {
res.send('Hello World!');
});
// Start your server
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});Options
The middleware accepts these options:
route: The endpoint where the uptime page will be available (default: "/uptime")startPort: The starting port number to try (default: 3000)maxPort: The maximum port number to try (default: 3100)
Features
- ✨ Clean, modern UI
- 🕒 Real-time timestamp updates
- 📱 Responsive design
- 🎨 Gradient background
- 🤖 Easy integration with existing Express apps
- 🔄 Automatic port finding
- 📊 Status monitoring
Example
After adding the middleware to your app, visit http://your-app-url/uptime to see the status page.
License
ISC
