Difference between revisions of "Raviga"

From mn/ifi/inf5750
Jump to: navigation, search
(Requirements)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Group Members ==
+
== Group Members ==
* Henriette Ekeberg
+
* Henriette Ekeberg  
 
* Håkon Thorkildsen Smørvik
 
* Håkon Thorkildsen Smørvik
* Marius Nilsen Kluften
+
* Marius Nilsen Kluften  
  
== Assignment ==
+
== Assignment ==
[[Sub-National Reports]]
+
[[Sub-National Reports]]  
  
== Requirements ==
+
== Requirements ==
The assignments involves creating an app that allows a user to select an existing pivot table (PT) or data visualiser (DV), and reproduce the favourite for a set of organisation units in a layout that makes them possible to compare. The app must have an interface for choosing the organisation units for which to reproduce the favourite. This assignment thus requires studying the metadata format for the favourites in to understand how it can modified to show the relevant organisation units, and then drawing it with the DHIS2 chart or pivot table [https://docs.dhis2.org/2.27/en/developer/html/webapi_plugins.html plugins].
+
''The assignments involves creating an app that allows a user to select an existing pivot table (PT) or data visualiser (DV), and reproduce the favourite for a set of organisation units in a layout that makes them possible to compare.''
  
It should be possible for an administrator (in this case users with the authority to add/edit public PT or DV favourites) to highlight certain favourites that are of particular relevance for this type of analysis in a shortlist of favourites, and for individual users to highlight favourites that they personally use often. This information could be saved using the dataStore (public) and userDataStore (private) API endpoints respectively.
+
- We need to create an interface which allows a user to view different charts and tables side-by-side to make the data more easily comparable.
  
Optionally, you can add support for:
+
''The app must have an interface for choosing the organisation units for which to reproduce the favourite.''  
* making new charts or tables from scratch ''within'' the app rather than starting with a pre-defined favourite
 
* add support for GIS favourites
 
  
== Architecture ==
+
- For example a list with checkboxes which is populated by the available OU's which dynamically updates the current favourites currently on display.
index.html -> page.html
+
 
 +
''This assignment thus requires studying the metadata format for the favourites in to understand how it can modified to show the relevant organisation units, and then drawing it with the DHIS2 chart or pivot table plugins.''
 +
 
 +
- We need to utilise the current DV and PT plugins to correctly display the relevant data for each organisation unit.
 +
 
 +
''It should be possible for an administrator (in this case users with the authority to add/edit public PT or DV favourites) to highlight certain favourites that are of particular relevance for this type of analysis in a shortlist of favourites.''
 +
 
 +
- We need to create an additional interface for an administrator which is used to manipulate available favourites for the users. Hide/Show etc. favourites, depending on relevance.  
  
== Frameworks ==
+
''And for individual users to highlight favourites that they personally use often.''
  
[https://vuejs.org/ Vue.js]
+
- A kind of "bookmark"-functionality for a user, to favourite a favourite.  
  
[https://bootstrap-vue.js.org/ Bootstrap Vue]
+
''This information could be saved using the dataStore (public) and userDataStore (private) API endpoints respectively.''
  
[http://reactivex.io/rxjs/ RxJS API]
+
- Securely store data using trusted endpoints.  
  
[https://webpack.github.io/ webpack]
+
''Optionally, you can add support for:''
 +
* ''making new charts or tables from scratch within the app rather than starting with a pre-defined favourite''
 +
** An interface which offers the same functionality to create a favourite as both the Pivot Table and the Data Visualizer offers.  
 +
* ''add support for GIS favourites''
 +
** Make it possible to add geographically represented charts as well, and make it easier to compare these.
  
[https://babeljs.io/ Babel]
+
== Overview - TODO ==
  
[https://eslint.org/ ESLint]
+
== Architecture ==
 +
Rough sketch: [http://52.213.11.2/home Project]
  
[https://expressjs.com/ Express]
+
== Frameworks ==
 +
* Vue.js
 +
* Bootstrap
 +
* Vue
 +
* RxJS API
 +
* webpack
 +
* Babel
 +
* ESLint
 +
* Express
 +
* @akanass/rx-http-request
  
[https://www.npmjs.com/package/@akanass/rx-http-request @akanass/rx-http-request]
+
== Timeline  ==
 +
[[File:Image.png|thumb]]
  
== Licensing ==
+
== Licensing - TODO ==
We are going to use some licenses.
+
We are going to use some licenses.  
  
== Division of labor ==
+
== Division of labor - TODO ==
100%/3 = 33%/per group member
+
100%/3 = 33%/per group member  
  
 
== Project Repository ==
 
== Project Repository ==
[https://github.uio.no/mariunkl/Raviga/settings/collaboration Raviga]
+
[https://github.uio.no/mariunkl/Raviga Raviga]

Latest revision as of 16:07, 1 November 2017

Group Members

  • Henriette Ekeberg
  • Håkon Thorkildsen Smørvik
  • Marius Nilsen Kluften

Assignment

Sub-National Reports

Requirements

The assignments involves creating an app that allows a user to select an existing pivot table (PT) or data visualiser (DV), and reproduce the favourite for a set of organisation units in a layout that makes them possible to compare.

- We need to create an interface which allows a user to view different charts and tables side-by-side to make the data more easily comparable.

The app must have an interface for choosing the organisation units for which to reproduce the favourite.

- For example a list with checkboxes which is populated by the available OU's which dynamically updates the current favourites currently on display.

This assignment thus requires studying the metadata format for the favourites in to understand how it can modified to show the relevant organisation units, and then drawing it with the DHIS2 chart or pivot table plugins.

- We need to utilise the current DV and PT plugins to correctly display the relevant data for each organisation unit.

It should be possible for an administrator (in this case users with the authority to add/edit public PT or DV favourites) to highlight certain favourites that are of particular relevance for this type of analysis in a shortlist of favourites.

- We need to create an additional interface for an administrator which is used to manipulate available favourites for the users. Hide/Show etc. favourites, depending on relevance.

And for individual users to highlight favourites that they personally use often.

- A kind of "bookmark"-functionality for a user, to favourite a favourite.

This information could be saved using the dataStore (public) and userDataStore (private) API endpoints respectively.

- Securely store data using trusted endpoints.

Optionally, you can add support for:

  • making new charts or tables from scratch within the app rather than starting with a pre-defined favourite
    • An interface which offers the same functionality to create a favourite as both the Pivot Table and the Data Visualizer offers.
  • add support for GIS favourites
    • Make it possible to add geographically represented charts as well, and make it easier to compare these.

Overview - TODO

Architecture

Rough sketch: Project

Frameworks

  • Vue.js
  • Bootstrap
  • Vue
  • RxJS API
  • webpack
  • Babel
  • ESLint
  • Express
  • @akanass/rx-http-request

Timeline

Image.png

Licensing - TODO

We are going to use some licenses.

Division of labor - TODO

100%/3 = 33%/per group member

Project Repository

Raviga