README.md

Clockwork-API

📶 Serverstatus | Administration API

Install

# Build
git clone https://github.com/Das-Uhrwerk/Clockwork-API.git
npm i

# Run
npm start
# the production server will run it via pm2

# Test
curl localhost:3000/api/

Routes

Currently the API only supports reading via GET, more information on the planned layout will be following up.

Route	Description
GET /server	List configured servers
GET /server/all	Query all serverdata
GET /server/:servername	Query single serverdata by servername
GET /server/all	Query all serverdata

---

Development stack

• Node.js LTS via npm
• nvm 🔗
• nvm for windows 🔗

Recommandation:

If you are developing on Windows consider the use of babun 🔗 until WSL (bash on windows) is fully ready for productive usage.