1.1.2 • Published 4 years ago
inkstatus v1.1.2
InkStatus
A Basic Nodejs Server Status Information app.
Table of Contents
- Requirements
- Installing
- Errors
- About
- Building from code
- Help
- Coming Soon
- Extra Info
- Other Branches
- Changing the app Ports
Requirements
- npm or Yarn
- Pyhton 2 + (To show RAM usage)
- PHP
Insatlling
You can install InkStatus with npm or Yarn.
- Yarn:
yarn add inkstatus
- npm:
npm i inkstatus -g
If you get a error trysudo npm install -g inkstatus
- HomeBrew:
brew tap lucaslah/inkstatus
then runbrew install inkstatus
Errors
- HomeBrew: Please put your error into a new issue.
About
This Project shows your computer CPU Info, Ram Usage, Uptime and lots more. Please Note This app is build for macOS and Liunx and Will be comming to Windows Soon, But you can fork this and build it for Windiws if you wish.
Building from code
- Clone this repo:
gh clone lucaslah/inkstatus
or using git clone:git clone https://github.com/lucaslah/inkstatus.git
- Change to the repo you just cloned:
cd inkstatus
- Install required things:
npm install
oryarn inatall
- Start the InkStatus server with
node . --start
- Start the PHP web Server with
node php
Help/Setup
- You will need php and yarn or npm installed on your computer (macOS or liunx).
- Install Inkstatus:
npm install inkstatus -g
oryarn add inkstatus
- In your terminal run this command:
inkstatus --start & inkstatus php
- Open http://localhost:5000 and you should see your computer status.
- To Quit inkstatus, In the terminal you ran
inkstatus --start & inkstatus php
in press CRT + C on your keyboard, thats it InkStatus has stoped. - Extra Note: While you have
inkstatus
running you MUST keep your terminal window open.
Coming Soon
- CPU Usage
Extra Info
THIS APP REQUIRES PORT'S 5000 AND PORT 5001.
Other Branches
- master : this branch also the main branch of this project.
- gh-pages : the branch where github pags for this project are hosted on.
- high-ports-x.x.x : the high ports branch for users that need higher ports, replace x.x.x with the current realese.
Changing the app ports (High Level Users only)
This page has moved. CHANGING-THE-APPS-PORTS.md