Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.71 KB

DEVELOPERS.md

File metadata and controls

42 lines (31 loc) · 1.71 KB
Raw

Goals

  • Call very few external programs (like df/load/uptime/etc), if any. (parse the file system for info, if possible)
  • Linux version does not use external programs at all and rely exclusively on /proc and /sys and connecting to locally listening daemons. (except for extensions, listed below)
  • Don't go nuts with eye candy. Don't use ajax. Make viewing the info on text only browsers possible and easy.
  • Any javascript ever used must degrade gracefully
  • Don't give info that can be exploited and turned into a security risk, especially not names and command line arguments given to running programs.
  • Don't use blatantly slow methods such as preg_split(), especially not in loops

Code style formatting

  • Use tabs for indention. This is legacy and probably should be 2 or 4 spaces instead
  • Opening curly braces go on same line. Closing curly braces go on their own line.
  • Look at existing code for more details

Basic development environment setup

  1. Install Docker Compose
  2. git clone the project anywhere you'd like
  3. Run cp sample.config.inc.php config.inc.php
  4. Run docker-compose up -d
  5. Access the web interface at http://localhost:8081/

Since your project root is mounted to the virtualized environment, any changes you make will appear immediately.

Rebuilding Javascript and Sass

This is only necessary if you are editing Javascript or Sass files.

  1. Install NPM
  2. Run npm install to install dependencies
  3. Run npm run dev for the development build
  4. Before checking in, run npm run production

Contributing