Dashdot-cli NPM

dash. is a open-source project, so any contribution is highly appreciated. If you are interested in further developing this project, have a look at the Contributing section of this readme.

In case you want to financially support this project, you can donate here.

Preview

Darkmode	Lightmode

Installation

Choose one of the following three ways to get your dashboard up and running

Docker

Images are hosted on docker.io, so you can easily use them with docker or other container engines

> docker container run -it \
  -p 3001:3001 \
  --name dashboard \
  mauricenino/dashdot

Configuration

You can configure your Docker-installed dashboard via environment variables inside the container. You can pass them by specifying them in your custom Dockerfile, or via the --env flag.

> docker container run -it \
  --env DASHDOT_PORT 80 \
  -p 3001:80 \
  --name dashboard \
  mauricenino/dashdot

To read more about configuration options, you cam visit the configuration section.

Node

The package is hosted as an executable on npmjs.com, so you can run it via npx

> npx dashdot-cli

Configuration

You can configure your Node-installed dashboard via environment variables, or by passing command-line arguments. Alternatively, you can also pass your config via CLI arguments.

> export DASHDOT_PORT=80
> npx dashdot-cli

> npx dashdot-cli DASHDOT_PORT=80

To read more about configuration options, you cam visit the configuration section.

Git

To download the repository and run it yourself, there are a few steps necessary:

If you have not already installed yarn, install it now:

> npm i -g yarn

After that, download and build the project (might take a few minutes)

> git clone https://github.com/MauriceNino/dashdot \
  && cd dashdot \
  && yarn \
  && yarn build

When done, you can run the dashboard by executing:

> yarn start

Configuration

You can configure your Git-installed dashboard via environment variables.

> export DASHDOT_PORT=80
> yarn start

To read more about configuration options, you cam visit the configuration section.

Configuration Options

The following configuration options are available.

If you dont know how to set them, look up the section for your type of installment (Docker, Node or Git).

Variable	Description	Default Value
DASHDOT_PORT	The port where the express backend is running (the backend serves the frontend, so it is the same port for both)	3001

Contributing

The simplest way of contributing is to create a new issue with a feature-request or bug-report.

If you are able to, you can also create a pull request to add the wanted features or fix the found bug.

To start working on this project, you can start by going through the Install - Git guide, but omit the yarn start part. When done, you can run the project in dev-mode using yarn run dev. This will start the express backend using nodemon and the react frontend using create-react-app.