Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/darekkay/dashboard

Customizable personal dashboard and startpage
https://github.com/darekkay/dashboard

dashboard react react-testing-library tailwindcss typescript

Last synced: 12 days ago
JSON representation

Customizable personal dashboard and startpage

Awesome Lists containing this project

README

        

# Dashboard

[![Build](https://img.shields.io/github/actions/workflow/status/darekkay/dashboard/ci.yml?branch=master&style=flat-square)](https://github.com/darekkay/dashboard/actions/workflows/ci.yml)
[![Gitter](https://img.shields.io/gitter/room/darekkay/dashboard?style=flat-square)](https://gitter.im/darekkay-dashboard/community)
[![license](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://github.com/darekkay/dashboard/blob/master/LICENSE)

![](docs/assets/img/dashboard.jpg)

## Project status

The project is under active development. While it is [live](https://dashboard.darekkay.com) already, I consider the status **late alpha** due to possible changes and the minimal amount of widgets.

## Goal

The goal of this project is a fully customizable and extendable dashboard, with modules like clock, weather, todo tasks, bookmarks, calendar, etc. The user should be able to view all important information on a single page.

- Create a browser start page with some common widgets.
- Display company-related information on TVs around the office.
- Display marketing information at an exhibition stand.
- Brainstorm ideas using notes and images.
- Monitor systems to ensure their availability and efficiency.
- Visualize your Internet of Things (IoT) devices.
- Create a [life engine](https://github.com/samsquire/ideas#5-life-engine).

Usually, I wait for a MVP before releasing a project. This project is being developed in public from Day 1. I document my progress and (knowledge) insights in the [blog](https://dashboard.darekkay.com/docs/blog/), while the [changelog](https://dashboard.darekkay.com/docs/changelog/) describes the actual project features.

The current state of the project is available at [dashboard.darekkay.com](https://dashboard.darekkay.com).

For more information, view the [official documentation](https://dashboard.darekkay.com/docs/).

## Motivation

Why build yet another dashboard app?

Most popular apps are neither open-source nor customizable to a degree I'd like it to be. Additionally, most open-source projects seem to be outdated.

A new project is also a great opportunity to learn new concepts.

## Features

- ☑ 16 [widgets](https://dashboard.darekkay.com/docs/widgets/) as of February 2023.
- ☑ Themes support. Because no one will bat an eye without a Dark Mode™.
- ☑ Multi-language support (English, German, French and Portuguese already provided).

## Contribution

Contributions are always welcome, no matter how large or small. Before contributing, please read the [Code of Conduct](./CODE_OF_CONDUCT.md). When contributing to this repository, please first discuss the change you wish to make via [GitHub Issue](https://github.com/darekkay/dashboard/issues/new) or join our community chat on [Gitter](https://gitter.im/darekkay-dashboard/community).

To get started with the project code, please read the [development documentation](https://dashboard.darekkay.com/docs/development/).

## Contributors

Thanks goes to these wonderful people:



darekkay
faboo03
TateKennington
adrianrios25
syentix
pinkahd
ludufre

This project follows the [all-contributors](https://allcontributors.org) specification to acknowledge all contributions.

## Attribution

Included icons created by [Font Awesome](https://fontawesome.com/license/free) and [Unicons](https://github.com/Iconscout/unicons).

## License

This project and its contents are open source under the [MIT license](LICENSE).