Dashboard Version 2

Currently in development. This is the next generation of dashboard that SCEL will be developing as part of Analysis, Distribution, and Visualization of Weather Data for Sustainability Applications.

Dashboard Repository:

https://github.com/scel-hawaii/dashboard_v2

Design Procedure

Design and Mock up any new ideas (web pages, functionality, components)
Generate electronic copy of any ideas (draw.io or other mock software)
Create Design Document for the idea
Develop Minimum Viable Product (MVP) based on design document
Re-evaluate the design document for any changes

Overall Block Diagram

All design docs and meeting details will be located under the current status tab.

Current Members S19

Jianna Orias
Allen Namoca
Andrew Salazar

Past Members SP18

Lead Developer: Kevin Cho
EE496: Gordon Li
Kyle Chan
Jonathan Lau
Akira Vernon
Kevin Liu
Jonathan Tu

If you are interested in working on the dashboard please contact the current lead developer. The lead developer will be able to give you access to the right repositories and will walk you through documentation on the wiki.

Development Tools

If you are planning on joining the dashboard team and have initiated talking to SCEL leadership about making the change, please begin with the following.

Download Google Chrome if you do not have it already. (Firefox Quantum is pretty comparable now days)
In Google Chrome install React Developer Tools. This will allow you to debug React-based websites
Install Yarn and NPM. We are currently using the Yarn package manager, but npm is also a powerful package manager
If you are unfamiliar with Javascript, then please check out freecodecamp to brush up.
Read and practice ES6 syntax in particular
Look at the React documentation

Current SCEL Software Members

If you are a current software member and have access to the repository please do the following.

Using Git, clone (git clone) the repository onto your main desktop in the folder you want to work on the project
Please consult with the lead developer/team member on which issue to work on. See current issues here.
Once assigned an issue create a new branch in the repository using
```
git checkout -b "issue#"
```
(# - issue number). Example branch in repository (issue01, issue02, issue03). You can find the issue # on the github issue you have been assigned.
Begin developing! You are free to edit any variables and do anything you can to get your code to work and to complete your issue. Change a few variables here and there and write readable code. You can run the React web app by navigating to the my-app directory and running the command
```
yarn dev
```
If you get some failures, please run yarn install to make sure all dependencies have been added to your folder and node_modules

Pushing your code

Are you ready to push your code? Please look at the following procedures before you decide to push.

Please triple check that your code will not break anything currently in production. If this means you need to write some unit tests/integration tests, then please do. More on writing tests later.
Find someone to review your code. This can be anyone who has familiarity with the codebase you are currently designing. If your current issue is to fix a “chart bug” and the owner of that component is currently on the software team, then please ask them to review the code in your branch. This can be done informally or through the code review tool on GitHub.
If you choose to do the code review informally, then the next step is to generate a code review with the lead developer of the dashboard. This will be the second and final check before merging in your new code. This can be accomplished by pressing the merge tool on the github website for our repository. If you have any questions please ask someone on the software team how to merge and create a code review properly.
If you decided to make a formal code review for step 1 you can just add the lead developer to that code review.
Once you have received two approvals then you can proceed to merge your changes into the master branch. If anything breaks, you are responsible for reverting those changes and assigning any new issues to yourself.

Some of the problems that the team has faced will be shown below.

D3.js is difficult to implement into a React App. The packages are deprecated and the documentation for making new D3 graph classes is weak.

Proposal
Preliminary Design Review (PDR)
Critical Design Review (CDR)
Final

Contributing authors:

anamoca asalazar avernon gli jorias jtu kcho kliu

Created by kcho on 2018/01/17 20:32.

Dashboard Version 2

Design Procedure

Overall Block Diagram

Current Status

Onboarding

Design Docs

Dashboard Meeting Notes

Current Members S19

Past Members SP18

Dashboard Deployment & Development

Development Tools

Current SCEL Software Members

Pushing your code

Problems/Resolutions

Presentations

Authors

Smart Campus Energy Lab Wiki