status-board / status-board

Status Board is a dashboard framework written in nodejs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

status-board

All Contributors Code Style Slack Channel Module LTS Adopted'

CircleCI Dependencies Dev Dependencies Maintainability Test Coverage License
master CircleCI dependencies Status devDependencies Status Maintainability codecov
1.x CircleCI dependencies Status devDependencies Status codecov
2.x CircleCI dependencies Status devDependencies Status codecov
beta CircleCI dependencies Status devDependencies Status codecov

Status Board is a fork of Atlasboard dashboard framework written in nodejs.

The last real update was over a year ago it seems development has went stale for the project.

I decided to fork it and release it under another name, and continue to improve it.

Installation

npm install status-board

This is specially useful during development so you only bring up the components you need.

Running your wallboard using Atlasboard as a module

From your wallboard directory, assuming that you have start.js run:

npm start

start.js looks like this and it is included in > 1.0:

const statusBoard = require('status-board').default;

statusBoard(
  {
    port: process.env.ATLASBOARD_PORT || 3000,
    install: false
  },
  function (err) {
    if (err) {
      throw err;
    }
  }
);

You'll need to add the Status Board dependency to your package.json.

Packages and resources

Documentation

Migrating from Atlasboard

Nothing is supposed to break once you upgrade but you may want to update a few things:

Module Long Term Support Policy

This module adopts the Module Long Term Support (LTS) policy, with the following End Of Life (EOL) dates:

Module Version Release Date Minimum EOL EOL With Status
1.x.x Nov 2017 Apr 2019 Node.js 6.x Current

Learn more about our LTS plan in docs.

Roadmap

Learn more about our reoadmap plan in docs.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

Contributors

Thanks goes to these wonderful people (emoji key):

James W. Lane III
James W. Lane III

💻 ⚠️ 🚇 🔧
Swami Kalagiri
Swami Kalagiri

💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Status Board is a dashboard framework written in nodejs.

License:MIT License


Languages

Language:JavaScript 63.5%Language:TypeScript 34.9%Language:Stylus 1.0%Language:EJS 0.6%