Difference between revisions of "Stockalyzr"

From mn/ifi/inf5750
Jump to: navigation, search
(Licensing)
(Architecture)
Line 11: Line 11:
  
 
== Architecture ==
 
== Architecture ==
We chose React as our main framework, as it's a widely used, well documented framework. We may use the [https://docs.dhis2.org/master/en/developer/html/webapi_plugins.html#webapi_chart_plugin Visualizer chart plug-in] if using charts will be necessary, and if the plugin gives us the necessary features.
+
We chose React as our main framework, as it's a widely used, well documented framework, and one of the team members had some previous experience with it. We also considered Angular.js, but it seemed like having a steeper learning curve and fewer third party components, and Vue.js, which is a less mature framework with fewer third party libraries (which turned out to be important for us). In retrospect, it would have made sense to use Redux or Flux, as there's a lot of data stored in a top-level component being passed down to child component. However, we decided against it as we already had our hands full learning React's state management system, and using Redux/Flux would add another layer of complexity and increase development time.
  
TODO: Describe the technical architecture of the product, including what frameworks you will be using (e.g. react, angular, others) and /why/ you have chosen these.
+
We decided to use Semantic-UI. It seemed to have all main components we were looking for, and seemed to have all the UI components we needed to build our app. It also has good support for response layouts, which was a plus.
 +
 
 +
For visualising data, we decided to use HighCharts because it is already used in DHIS2's [https://docs.dhis2.org/master/en/developer/html/webapi_plugins.html#webapi_chart_plugin Visualizer chart plug-in], so we assume that DHIS2 has a valid license for it. It also has a much simpler API than a library such as D3.js, and is more powerful than similar open source libraries such as Chart.js.
  
 
=== Timeline ===
 
=== Timeline ===

Revision as of 17:13, 3 December 2017

Team members

  • Mathias Stang (mjstang)
  • Patryk Kucmann (patrykk)
  • Guro Møller Ødegård (guromod)
  • Pavel Shramau (pavelsh)

Product descriptions requirements

Stock Level Visualisations

The app should let the user choose one or more organisations, as well as the indicators/data elements. This should display the estimated months of stock left for the selected elements, possibly also the estimated time until stocks reach minimum limit, and a visualisation of the time-trend of stock availability. The administrators should be able to change default limits.

Architecture

We chose React as our main framework, as it's a widely used, well documented framework, and one of the team members had some previous experience with it. We also considered Angular.js, but it seemed like having a steeper learning curve and fewer third party components, and Vue.js, which is a less mature framework with fewer third party libraries (which turned out to be important for us). In retrospect, it would have made sense to use Redux or Flux, as there's a lot of data stored in a top-level component being passed down to child component. However, we decided against it as we already had our hands full learning React's state management system, and using Redux/Flux would add another layer of complexity and increase development time.

We decided to use Semantic-UI. It seemed to have all main components we were looking for, and seemed to have all the UI components we needed to build our app. It also has good support for response layouts, which was a plus.

For visualising data, we decided to use HighCharts because it is already used in DHIS2's Visualizer chart plug-in, so we assume that DHIS2 has a valid license for it. It also has a much simpler API than a library such as D3.js, and is more powerful than similar open source libraries such as Chart.js.

Timeline

  • November, 1st - wiki page, understanding of DHIS2 API needed for the application, frameworks and tools to be used are defined.
  • November, 7th - general look and design of the application, functional and non-functional requirements specified, start of implementation.
  • November, 26th - end of implementation, start of testing and debugging.
  • December, 1st - project done, start of presentation preparation.
  • December, 4th - presentation made.

Group meetings, problems discussions and temporary result evaluations every Tuesday and Friday.

Licensing

In our project we are using React as the only JS-framework to develop the application. React was using BSD+patents licence before, but from version 16 it is licensed under permissive MIT licence. This grants us the permission to use React in any way with only one condition, which is to include the copyright notice. Since we are interested in developing a fully open source application with source code published as it is on GitHub and the only framework we are using is React, Stockalyzr will be released by MIT licence too.

DHIS2 is using BSD licence, but we are using only Open API's from DHIS2, so it does not come under consideration.

Division of labour

TODO: Describe how tasks are divided within the group.

Repository

GitHub repository