App

A dashboard application

Contract

• The index.html file will be the only html file (as it is a SPA) and it must be SSR, SEO optimized and functional before the javascript loads.
• The only javascript loaded on page load is the application core (as minimal as possible). Everything else should be imported dynamically to keep the page loading as quickly as possible.
• Every core functionality should be defined as a component, accessible for re usage when defining new routes.
• The application's views are accessed by routing the page's hash, and any change in the page's state must result in a different hash to be able to share links with a well-defined state.
• It must be possible, without touching the core of the application, to add new routes and functionalities respecting the defined principles and without having to use any type of build tools.

Implementation

The objectives defined contractually are ambitious and it will be necessary to evolve the technologies involved along with the development of the application.

To start development, it will be necessary to make non-optimal choices that may eventually be replaced in the future.

• Bootstrap: Despite bringing extra javascript and not being exactly minimal, it manages to preserve good consistency between sites, and is extremely tested and has features that will speed up development, in addition to being easily customized using projects like Bootswatch.
• Font-Awesome: The most popular icon library, essential for creating intuitive user interfaces.
• JSON Schema: A level of abstraction to bring user-defined tables and forms to the application with minimum effort and maximum customization.

TODO

Bugs and improvements

• remove setOptions and setValue, replace ctrl instead
• remove readOnly use update instead, use readOnly instead of writeOnly
• no default option fail to expose error message
• group as a modal
• all update functionality centralized in ctrl
• allow link with options (dropdown)
• move table engine to user space
• allow children in docs and examples (ctrl case)
• print goes with JSON and not as a raw function
• allow to see other tests variants
• remove lang support
• remove non bootstrap options support, minimize options and review settings
• nav as offcanvas and move all nav configuration to settings
• remove base64 file support
• emoji support on icons

New Controls

• select list
• radio list
• checkbox multiple list
• array of itens

Tests and docs

• chart
• graph
• render
• link
• input
• form
• modal
• table
• nav
• core router

New components

• footer
• barcode
• carousel
• maps

Contributing

It's a very simple project. Any contribution, any feedback is greatly appreciated.