Skip to content

Latest commit

 

History

History
82 lines (50 loc) · 4.9 KB

README.md

File metadata and controls

82 lines (50 loc) · 4.9 KB
Raw

RasDash

A Raspberry Pi dashboard built on NodeJS.
~ Status ~ Install ~ Configure ~ Run ~ Update ~ Uninstall ~ Guidelines ~ Subreddit ~


Project State

A moderate rewrite, v1.0.0, is in the works because I've really grown as a dev since starting this project and I think it's time for me to use these skills to make this just a bit greater. A lot of the code in this application has been sitting around since like v0.1.0, which was never actually put into the releases page. As of now, backend-side of things will remain completely the same as it works well.

My plans for the 1.0.0 rewrite are to simply redo the UI. After this UI refresh I think RasDash will be finally on it's way to, what I would consider, being a great little application. For those who worry the UI will completely deviate from the current layout, don't. As of now, I do not plan to change the layout at all, I just plan to switch the style to work well with all browsers, and on most screen sizes as I see this may be a good tool for checking a Pi's status from some mobile device.

All work for this refresh will be done in the 1.0-rewrite branch as to not interfere with the current code.


Build Testing Status

Branch Status
Master AppVeyor
Latest Release AppVeyor
Live Demo Heroku

Installing RasDash

Installing RasDash is pretty easy:

  1. On a Raspberry Pi running PiXEL, run the following command in your terminal: git clone https://github.com/sykeben/RasDash.git ~/RasDash, this will clone the current version of the code to your device.
  2. Once cloned, run cd ~/RasDash; sudo ./install_deps, this will install all dependencies for RasDash.
  3. After all that, you can install the RasDash service by running cd ~/RasDash; ./service_manager install; ./service_manager start.

Changing the Config

If for some reason RasDash is conflicting with ports from another process, you can change the ~/RasDash/config.json file's port property to be any other port that works for you. After changing the config please restart RasDash by running cd ~/RasDash; ./service_manager restart.


Starting/Stopping/Restarting RasDash

All service related functions can be managed via the service_manager script. It can start, stop, restart, install, and uninstall the RasDash service.


Updating RasDash

Updating RasDash is pretty easy. Just repull the repo to ~/RasDash and restart the service.


Uninstalling RasDash

If for some reason your unhappy with RasDash, you can uninstall it:

  1. First, let's remove the service. Run cd ~/RasDash; ./service_manager stop; ./service_manager uninstall.
  2. Now, all we need to do is remove the files left. Run rm -rf ~/RasDash to make them disappear.

Community Perception

More information about RasDash from the community (and me) has been written on...


Guidelines

If you want to submit code, write an issue/pull request, or comment, you should read these documents first:

By reading these docs, it makes it easier for you (and me) to work on issues, changes, and more.