thhomas / dashboard-creator Goto Github PK

• parse DATA operation when operand is an attribute
• parse DATA operation when operand is a SDMX URL
• parse DATA with multiple SDMX URL

On home page:

• Add links to view/download YAML
• Add link to remove dashboards by either:
  • delete YAML from local uploads
  • delete gists

Allow to specify font type, size, emphasis (bold, italics, etc.) and location (LEFT, CENTER, RIGHT) in square-brackets ([]) following the VALUE chartType in order to override the default font. (e.g. VALUE, [Arial, 32, Bold, CENTER]).

to check

Footer title and subtitles should be displayed at the bottom, not right after TITLE

Option to store YAML file as Gists as a temporary solution.

See gists npm package.

From Edgardo's email, nice-to-have number 4:
If a yaml file is deleted from the dashboard management screen, the screen must refresh and the deleted file disappear.

Try use signals instead of state hooks.
https://www.npmjs.com/package/@preact/signals-react

This allows managing a state in a single place and still use data in many components, without having to re-render the whole app (even if state is managed in the main app component).

LINES chart do not display with monthly data but works well with annual data.
Examples:
https://dashboard-creator-thhomas-projects.vercel.app/chart/ExampleMULT4
https://dashboard-creator-thhomas-projects.vercel.app/chart/SDMXTraining

mandatory:

• VALUE
• PIE
• LINE
• BAR
• DRILLDOWN

extra:

• MAP

Title and subtitles to be parsed according to ToR

• Clean up title
• Add style for TITLE and FOOTER (Bootstrap CSS)
• Add style for Highcharts components
• Parse concepts

Style
Font type, size, emphasis (bold, italics, etc.) and location (LEFT, CENTER, RIGHT) can be specified in square-brackets ([]) following any text, title, note or label specification.

Example: Title: "Labour force participation rate, [Arial, 14, Bold, Italics, CENTER]”

Concepts
Inside a string or in a data operation, concepts’ values can be referenced by specifying them in curly brackets ({}).

• If the concept id is prefixed by a dollar sign $, the name of the represented item is to be returned instead
  i.e. while {<concept_Id>} returns the content of <concept_id> dimension or attribute, {$<concept_Id>} returns the name of the item corresponding to the content of the dimension or attribute represented by <concept_Id> (e.g. {SEX} = M, {$SEX} = Male).
• {$TIME_PERIOD} is always displayed as the period expressed in natural language.
  (e.g., {TIME_PERIOD} = 2020-M05, {$TIME_PERIOD} = May 2020, or Mayo 2020 if locale=es).

“Decimals:” in “VALUES” chart with an integer works well but with {$DECIMALS} it displays the value of DECIMALS instead of the OBS_VALUE with $DECIMALS decimal places. (see example https://dashboard-creator-thhomas-projects.vercel.app/chart/ExampleMULT4)

_The product will be delivered in a GIT repository containing the source code and descriptive documentation.

It must include a user’s guide in English with enough information to deploy and run the submitted application files_

eg. 2021-M02
https://sdmx-greising.lmis.solutions/rest/data/CL01,DF_TRLMULT,1.0/.M.?startPeriod=2017-10&endPeriod=2021-12&format=jsondata

A fairly simple way would be to deploy automatically to Vercel
https://vercel.com/docs/concepts/deployments/git/vercel-for-github

We can stick with free "hoby" plan for this project.

Only current restriction would be the way we currently store YAML files: we can't save them in the file system once on Vercel.
See Ticket #5 about saving in Gists.

In order to be able to integrate dashboards in web pages in any website (which is the final goal really), we need to decouple the application, meaning separate the front-end and back-end in 2 separate projects.

Backend
NextJS will still be handling the config file uploads and management, and provide API end point to serve those files to the front end.
You will still be able to access a dashboard by going to https://<host>/chart/<dashID>

Frontend
This will now be a pure ReactJS project and only display the dashboard itself.

A few key points to keep in mind for the React app

• Root component will be passed on the URL to the config file to load it
• The navigation menu will be removed as it will make no sense once integrated in a web page
• We wil add CSS classes to components so style can be defined on the host website CSS

We also need to document how to style highcharts charts to match host website.

Does this make sense?
Am I missing anything?

Dashboard Generator will handle the multilingual capacities of SDMX for the data and
metadata displayed, not for the application configuration or dashboard settings which will be in
English. The language should be set as a context variable for the application displaying the dashboard
and all labels and texts must be displayed in such language, provided the locale is available for the API
consumed. Otherwise, it will default to a configurable language.

So, if we have time:

• Add default language as environment variable
• Add parameter in URL to use specific language

@thhomas je ne suis pas très content du design général et de la navigation que j'ai mis en place, je pense que je vais simplifier.

• Au lieu d'utiliser une slidebar je pense utiliser le composant offcanvas de bootstrap, ce qui permettera de vraiment focaliser l'attention des utilisateurs sur le dashboard en lui-même.
• Supprimer la navbar du haut, mais conserver le bouton (hamburger icon?) pour ouvrir le offcanvas
• Déplacer l'upload dans une page spécifique
• Dans le offcanvas afficher:
  • Un logo/titre pour le dashboard creator (lien vers la page d'accueil)
  • La liste des dashboards disponibles
  • Un lien vers la page d'upload
• Revoir la page d'accueil, affichant:
  • Informations générales, lien vers la doc, etc.
  • Liste des dashboards
  • Lien vers la page d'upload