express-control-room
Version:
Express Control Room is a middleware package for the Express.js framework designed to provide a centralized control interface for managing and monitoring various aspects of your Express application and the server. It offers features such as real-time logg
65 lines (43 loc) • 2.01 kB
Markdown
# express-control-room
[](https://www.npmjs.com/package/express-control-room)
Express Control Room is a middleware package for the Express.js framework designed to provide a centralized control interface for managing and monitoring various aspects of your Express application and the server. It offers features such as real-time logging, route management, and request/response inspection, server monitoring.
### Installation
```bash
npm i express-control-room
```
### Getting started
```javascript
const express = require('express');
const { ControlRoom } = require('express-control-room');
const app = express();
const port = 3000;
// Define a route
app.get('/', (req, res) => {
res.send('Hello, World!');
});
// connect ControlRoom into express using middleware
app.use(ControlRoom);
// Start the server
app.listen(port, () => {
console.log(`Server is running on http://localhost:${port}`);
});
```
### Usage
1. [Duck DB](https://duckdb.org/)
2. [Server Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)
3. [PM2](https://pm2.keymetrics.io/docs/usage/quick-start/)
### Features
- [x] Custom logs store and realtime response
- [ ] Real-time logging of server activities.
- [ ] Dynamic route management and inspection.
- [ ] Request and response analysis for debugging.
- [ ] Request logs store and realtime response
- [ ] PM2 application management
### API's and Stream's
| Method | URL | Comments |
|--------|------------------------------------------|---------------------------------------|
| GET | /control-room/utils | Returns server details |
| GET | /control-room/token | Returns auth token |
| GET | /control-room/logs/default/stream | SSE stream default logs on realtime |
### License
MIT