Skip to content

cawasser/vanilla

Repository files navigation

vanilla

contributors activity clojure version

This single-page application (SPA) provides a number of graphical widgets based on Highcharts

History

look here

0.5.0 - "Epochal time". This version supports data expressed as a series of "snapshots" over time. See Handling Epochal Time for more details.

Roadmap

Client-side

  • improve chart conversions between the various :data-format/<> types

  • user picker for colors and title, using [cljsjs/react-color "2.13.8-0"]

  • move some of the viz stuff (labels, etc) to the service definition/data-message to make more declarative (mix-in? where?)

  • allow widgets to publish/subscribe user selection events so multiple widgets can work together

  • login

  • store widget layout for each user (and restore on next login)

  • spec the data structures (:data-format/*)

  • generative testing of the client

  • migrate the widget defs to the server and load them dynamically (can this be done with a push from the server? that way the client will get the updates as soon as we put them on the server-farm)

  • figure out how to let the user pick the charts in a stacked or side-by-side (DROPPED)

Services-side

Development

Writing new code

Running the application

Architecture

Auto-Documentation

Marginalia and more specifically lein-marginaliahas been added as a plugin to this project to keep a healthy level of documentation of our codebase and architecture. The plugin essentially scans through the project and creates an html "wiki" of how our project operates. It takes all our in line comments and can be added to easily to explain certain namespaces, functions, or design decisions.

To run the plugin and generate the aforementioned wiki simply use:

lein marg

This will generate the file:

./docs/uberdoc.html

Here is the document it generates:

marginalia-uberdoc

Generated Diagrams

Diagrams are generated "automatically" by ???

see also

Note: cdk-clj has been abandoned by the developers.

User Guide

FAQ

Write the Docs

About

A vanilla "dashboard" built on dashboard-clj (https://github.com/multunus/dashboard-clj)

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors