Skip to content
This repository has been archived by the owner on Jun 8, 2021. It is now read-only.

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cord committed Jun 29, 2020
1 parent 40d9cb6 commit 72d1009
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 19 deletions.
22 changes: 3 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

# Nova Databoards

Analytics Databoards for Laravel Nova
Provides ready-to-use Analytics Databoards for Laravel Nova

![](docs/nova-databoards-1.gif)

The Benefits of using Nova Databoards compared to the default Nova Metrics:

### Seperation of metric calculation and visualisation

The Nova-Databoards metric classes are the container for all metric calculations. The calculations are adoptable to the supported visualisations, so e.g. within a `Users`-metric you can calculate e.g. the total number of users for a Value-Visualisation or provide Trend-Data for a Trend-Visualisation.
Expand All @@ -27,18 +25,6 @@ By adding the Trait `nova-bi/nova-databoards/src/Traits/DynamicMetricsTrait.php`
Thumbs up to [Muzaffer Dede](https://novapackages.com/collaborators/muzafferdede) for developing [Nova Global Filter](https://novapackages.com/packages/nemrutco/nova-global-filter), which is essential for dynamic updates of the widgets on changing filters.


## Table of contents

- [Introduction](#introduction)
- [Installation](#installation)
- [Playground](#playground)
- [Extending](#extending)
- [Roadmap](#roadmap)
- [Known Issues](#known-issues)
- [Changelog](#changelog)
- [License](#license)


## Introduction

Data visualisation is a common business requirement. The default [Nova Metrics](https://nova.laravel.com/docs/3.0/metrics/defining-metrics.html#value-metrics) are providing a simple way to display certain data from your application.
Expand Down Expand Up @@ -221,14 +207,15 @@ You can place your custom Resources and Models in any subdirectory. To make them
- data range filter using (https://innologica.github.io/vue2-daterange-picker)
- enhance filter bar with main filters (always visibile) and secondary filters (click on button to add)
- Adding layout flexibility to Nova Cards (e.g. height, sort-order)
- artisan command to generate metrics, visuals
- adding visuals, e.g. Chart JS, Google Charts, APEX with common data api
- interactive visuals (todo - click on e.g. a partition will set a filter, which updates all widgets)
- expose metric data through API for external visualisation
- adding ETL for data aggregation
- GUI enhancements
- select metric with icons / description
- select visuals with icons / description
- select filters with icons / description-
- select filters with icons / description
- drag & drop sorting of widgets


Expand Down Expand Up @@ -266,6 +253,3 @@ This package is highly depending on following selection of packages from the hug
## License

This software is released under [The MIT License (MIT)](LICENSE).


-
Binary file modified docs/nova-databoards-2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 72d1009

Please sign in to comment.