https://github.com/joereynolds/fanbox

A HTML + CSS + JS desktop dashboard!
https://github.com/joereynolds/fanbox

Last synced: about 2 months ago
JSON representation

A HTML + CSS + JS desktop dashboard!

• Host: GitHub
• URL: https://github.com/joereynolds/fanbox
• Owner: joereynolds
• License: gpl-3.0
• Created: 2016-05-26T21:24:25.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T19:32:42.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T22:47:27.776Z (5 months ago)
• Language: HTML
• Homepage:
• Size: 397 KB
• Stars: 94
• Watchers: 2
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fanbox

[![bitHound Overall Score](https://www.bithound.io/github/joereynolds/fanbox/badges/score.svg)](https://www.bithound.io/github/joereynolds/fanbox)

## Installation

### Debian distros

Download and install the `.deb` package on the [releases](https://github.com/joereynolds/fanbox/releases) page.

### Everyone else

```

git clone https://github.com/joereynolds/fanbox

npm install

npm start

```

## Examples

![alt-text](simple.png)

![alt-text](fanbox.gif)

## Fanbox

Fanbox is a desktop dashboard (like conky) built on HTML, CSS, and Javascript.

Fanbox is created and styled with HTML and CSS so anyone comfortable with those two things should feel right at home with fanbox. 

There are no made-up tags or any scripts to adjust, just HTML.

## Getting started

See the [getting started](docs/getting-started.md) guide for a complete run through of creating a theme.

## Examples

Here are a few examples of what Fanbox comes with out of the box

### HTML classes to display system information

```

  

  


    


  


  

  


    


  


  

  


    


  


  

  


    


  


  

  


    

  


```

### Execute raw shell commands

Fanbox doesn't come with everything under the sun, if it's missing something you need, you can add it in yourself with some shell-fu!

Just give a tag the ```raw-command``` class and inject your command into ```data-command``` like so

```



  



```


This be can be further expanded to provide actual useful information like battery level and volume level.

```



  



```

```



```

### Contributing.

If you'd like to contribute, first off, thank you!

You can read more with our [contribution guide](docs/contributing.md)

### Reference

For a complete reference of every HTML class available and the various ```data-format```s please see the [reference](docs/reference.md) guide