Difference between revisions of "Full-Stock-Developers"
From mn/ifi/inf5750
(→Division of labour) (Tag: Visual edit) |
(Screenshot) (Tag: Visual edit) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 10: | Line 10: | ||
== Product overview == | == Product overview == | ||
| − | The application will include | + | The application will include three different features: |
| − | * ''' | + | * '''Admin control:''' An user with admin privieges is able to freely form StockGroups using a selection of dataElements, and/or Indicators. The stockGroup will contain a reference to a dataset containging starting balance, and a set of references to contributors to the monthly depletion of stock. For instance units consumed, units discarded, units lost and more. Within the admin control menu is also the option to set min and max values, referring to the minimum and maximum number of months of stock usage the admin wish to retain each month. Lastly, the admin user is able to name the stockGroup. |
| − | |||
| − | + | * '''Stock visualizer:''' We display Stock visualizer as a bar graph, where each bar is an organizational unit's months of stock left. This number is calculated by dividing the current level of stock left with the average use of that stock. The user is able so select among the admin-created stockGroups and combine it with one or more organisational units to display estimated months of stock left given the prior 12 months of usage data. The user will be notified if the time left is above or below the set min or max values, set by the admin. | |
| − | + | * '''Time trend view:''' The user is able to select one of the admin-created StockGroups, and one organisational unit. The Time trend view then displays a line graph with the fluctuating availability of a stock, as well as an average of this availability. The data is analyzed using linear regression analysis and projected into the next six months. The chart will also display the chosen levels of minimum and maximum values for that stockGroup. | |
| − | + | {| class="wikitable" | |
| − | + | ![[File:TimeTrend.png|alt=Time trend|thumb|Time trend]] | |
| − | + | ![[File:StockLeft.png|alt=Stock left|thumb|Stock left]] | |
| + | ![[File:Admin Menu.png|alt=Admin menu|thumb|Admin menu]] | ||
| + | |} | ||
=== Requirements === | === Requirements === | ||
| Line 24: | Line 25: | ||
== Architecture == | == Architecture == | ||
''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.'' | ''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 chose Angular as one of our group members had experience with the framework. Angular Material was chosen as it is a natural combination with Angular, as well as it is standard for Dhis2. ng2-charts was chosen, as it is one of the few chart libraries for Angular. Further, Angular CLI is almost a must for any Angular project. It speeds up the creation of new components as well as other features. Flex-Layout was chosen as our one group member had positive experience with how it styles the page content. Material design icons are a good combination with Material. Sass has little downsides compared to css, so we included it as default in our project. | ||
| + | |||
| + | [[File:Angular App structure.png|thumb|App Structure]] | ||
=== Main frameworks === | === Main frameworks === | ||
| Line 44: | Line 49: | ||
[[File:Rough timeline.png|none|thumb|480x480px]] | [[File:Rough timeline.png|none|thumb|480x480px]] | ||
| − | === Division of | + | === Division of labor === |
1.nov: | 1.nov: | ||
* Kristoffer: get a basic visual framework up and running. | * Kristoffer: get a basic visual framework up and running. | ||
* Andreas: start working on finding the API calls for the parameters of the stock visualizer view. | * Andreas: start working on finding the API calls for the parameters of the stock visualizer view. | ||
| − | * Ole: start working on finding the API calls | + | * Ole: start working on finding the API calls necessary in the time trend view. |
* Lukas: start working on creating a table in the API for registering min and max values for a given OU/SKU pair. | * Lukas: start working on creating a table in the API for registering min and max values for a given OU/SKU pair. | ||
| + | 7.des: | ||
| + | * Kristoffer: Services, Angular interaction, Async issues, /datastore, Medic | ||
| + | * Andreas: StockGroup, admin menu, some services and styling | ||
| + | * Lukas: Organisation Units, necessary Org.unit menues for user and admin | ||
| + | * Ole: Exploration of the API--> Analytics, Time trend, Months left, use of min/max | ||
=== Licensing === | === Licensing === | ||
''Discuss the implications (if any) on the product you are development from the software licenses of the frameworks and libraries you are using.'' | ''Discuss the implications (if any) on the product you are development from the software licenses of the frameworks and libraries you are using.'' | ||
| − | + | All our frameworks use the liberal MIT license. This means that only credit is needed. | |
| − | |||
| − | |||
== Github repository == | == Github repository == | ||
[https://github.uio.no/krisaso/Stock-Level-Visualiser Github] | [https://github.uio.no/krisaso/Stock-Level-Visualiser Github] | ||
Latest revision as of 16:09, 7 December 2017
Contents
Members
- Andreas Finn Hansen (andrefh)
- Kristoffer Solheim (krisaso)
- Lukas Vannini (lukasva)
- Ole Marius Haanæs (omhaanae)
Assignment
Product overview
The application will include three different features:
- Admin control: An user with admin privieges is able to freely form StockGroups using a selection of dataElements, and/or Indicators. The stockGroup will contain a reference to a dataset containging starting balance, and a set of references to contributors to the monthly depletion of stock. For instance units consumed, units discarded, units lost and more. Within the admin control menu is also the option to set min and max values, referring to the minimum and maximum number of months of stock usage the admin wish to retain each month. Lastly, the admin user is able to name the stockGroup.
- Stock visualizer: We display Stock visualizer as a bar graph, where each bar is an organizational unit's months of stock left. This number is calculated by dividing the current level of stock left with the average use of that stock. The user is able so select among the admin-created stockGroups and combine it with one or more organisational units to display estimated months of stock left given the prior 12 months of usage data. The user will be notified if the time left is above or below the set min or max values, set by the admin.
- Time trend view: The user is able to select one of the admin-created StockGroups, and one organisational unit. The Time trend view then displays a line graph with the fluctuating availability of a stock, as well as an average of this availability. The data is analyzed using linear regression analysis and projected into the next six months. The chart will also display the chosen levels of minimum and maximum values for that stockGroup.
Requirements
Architecture
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 chose Angular as one of our group members had experience with the framework. Angular Material was chosen as it is a natural combination with Angular, as well as it is standard for Dhis2. ng2-charts was chosen, as it is one of the few chart libraries for Angular. Further, Angular CLI is almost a must for any Angular project. It speeds up the creation of new components as well as other features. Flex-Layout was chosen as our one group member had positive experience with how it styles the page content. Material design icons are a good combination with Material. Sass has little downsides compared to css, so we included it as default in our project.
Main frameworks
ng2-charts (based on Chart.js)
Other frameworks
Development
Division of labor
1.nov:
- Kristoffer: get a basic visual framework up and running.
- Andreas: start working on finding the API calls for the parameters of the stock visualizer view.
- Ole: start working on finding the API calls necessary in the time trend view.
- Lukas: start working on creating a table in the API for registering min and max values for a given OU/SKU pair.
7.des:
- Kristoffer: Services, Angular interaction, Async issues, /datastore, Medic
- Andreas: StockGroup, admin menu, some services and styling
- Lukas: Organisation Units, necessary Org.unit menues for user and admin
- Ole: Exploration of the API--> Analytics, Time trend, Months left, use of min/max
Licensing
Discuss the implications (if any) on the product you are development from the software licenses of the frameworks and libraries you are using.
All our frameworks use the liberal MIT license. This means that only credit is needed.
