/my-server-status-api

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

Primary LanguageTypeScript

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.

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