Improvement: add serve dashboard command / static page

[cbraillon]

Q	A
Bug report?	no
Feature request?	yes
Library version	latest

It would be great to see results in a dashboard.
I know that Symfony Insight has one and it's awesome.

It will increase the readability of issues.

[caneco]

I wouldn't mind to tackle this… 🔥 🔥 🔥

[olivernybroe]

We have a PR for adding formatters #201, which will make doing this a lot easier.

I see two ways of implementing this. Either create a new formatter called html, which generates a site from the output. Or create a site which can load the data from the json format.

[caneco]

@olivernybroe in each run we could add a new JSON file to a specific folder that a HTML would read an present the key figures and charts.

Feels like the best approach, and also to show the progress of the insights results.

[olivernybroe]

@caneco Sounds like a good idea. I think the JSON way is more robust and extendable in the future.

Would also do so you could compare your results for each run 👍

Maybe this dashboard should be a package for itself that you can just composer require in?

[caneco]

Could be something installed if needed with npm run install && npm run build/serve?

[olivernybroe]

@caneco Yeah, it makes a ton of sense to use npm instead as it is front end stuff.

[caneco]

Another question…

Should the dashboard be:

• only available by running a local server (npm run serve)
• available as a "static" website in the repo (npm run build)
• or… both

[olivernybroe]

I think a static site might be the best choice, if that is not too much work. Else just do what you find easiest.

[cbraillon]

Love the idea of a static site !

[nunomaduro]

Thanks to @olivernybroe, we can know get json format from phpinsights.