https://github.com/jgeek00/my-server-status-api

REST API that provides realtime info about your server's hardware.
https://github.com/jgeek00/my-server-status-api

hardware hardware-information nodejs performance-metrics performance-monitoring rest-api

Last synced: 18 days ago
JSON representation

REST API that provides realtime info about your server's hardware.

• Host: GitHub
• URL: https://github.com/jgeek00/my-server-status-api
• Owner: JGeek00
• Created: 2023-03-02T20:13:41.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-07T20:03:35.000Z (7 months ago)
• Last Synced: 2024-10-11T02:31:22.743Z (about 1 month ago)
• Topics: hardware, hardware-information, nodejs, performance-metrics, performance-monitoring, rest-api
• Language: TypeScript
• Homepage:
• Size: 149 KB
• Stars: 31
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  





  REST API that provides system information








  My Server Status application repository











My Server Status works thanks to Systeminformation, a Node.js library that exposes hardware status and specifications. 








  ⚠️ PROJECT DISCONTINUED ⚠️

  


  This project is discontinued and won't receive more updates. If you are looking for a server monitoring API, I recommend you checking out Status.






## How to deploy

[Deployment instructions.](https://github.com/JGeek00/my-server-status-api/wiki/Deployment-instructions)

## How to develop

⚠️ The API requires root access on Windows and Linux ⚠️

1. Clone this repository.

2. The recommended Node.js version is ``v20``.

3. Run ``npm install``.

4. The API by default starts on port 3000. If you want to use another port, create a .env file and declare there the ``PORT`` variable with the desired port.

5. Run ``npm run dev`` to start the API.







Created by JGeek00