Differences

This shows you the differences between two versions of the page.

--- weatherbox:dashboard_v3:start [2020/02/25 02:40]
kliu [Current Status]
+++ weatherbox:dashboard_v3:start [2021/09/19 21:59] (current)
@@ Line 1: / Line 1: @@
 ======Dashboard Version 3======
-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.
+This is the current version of the Dashboard, utilizing a ReactJS framework. This is the next generation of the 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_v3]]
+  * [[https://github.com/scel-hawaii/dashboard_v3_react|Current Dashboard V3 - ReactJS]]
+  * [[https://github.com/scel-hawaii/dashboard_v3|Previous Dashboard V3 - HTML]]
 === Design Procedure ===
@@ Line 12: / Line 13: @@
   - Develop Minimum Viable Product (MVP) based on design document
   - Re-evaluate the design document for any changes
+{{ :weatherbox:dashboard_v3:design_procedure.png?600 |}}
 === Overall Block Diagram ===
-{{ :weatherbox:dashboard_v2:overall_block_diagram.png?600 |}}
+  - Weatherboxes will send packets to the database
+  - Dashboard will pull results from specific weatherboxes in pages
+{{ :weatherbox:dashboard_v3:block_diagram.png?600 |}}
 ----
@@ Line 25: / Line 28: @@
 === Design Docs ===
+[[weatherbox::dashboard_v3::components::start |Dashboard Components Overview]]\\
+[[weatherbox::dashboard_v3::resources::start |Online Resources/Tutorials]]\\
+[[weatherbox::dashboard_v3::improvements::start |Future Improvements]]\\
+**Previous Relevant Design Docs**:\\
 [[weatherbox::dashboard_v2::techstack::start |Tech Stack Overview]]\\
-[[weatherbox::dashboard_v2::semantic::start |CSS Framework Design Doc]]\\
-[[weatherbox::dashboard_v2::graphsoftware::start |Graph Library Design Doc]]\\
-[[weatherbox::dashboard_v2::mappingsoftware::start |Mapping Software Design Doc]]\\
 [[weatherbox::dashboard_v2::react::start |React Design Doc]]\\
-[[weatherbox::dashboard_v2::redux::start |Redux Design Doc]]\\
-[[weatherbox::dashboard_v2::webapi::start |Weatherbox API Design Doc]]\\
-[[weatherbox::dashboard_v2::database::start |Database Design Considerations]]\\
-[[weatherbox::dashboard_v2::reusablecomp::start |Designing Reusable Components]]\\
-[[weatherbox::dashboard_v2::GraphGenerator::start |Graph Generator]]\\
-[[weatherbox::dashboard_v2::landingpage::start |Landing Page]]\\
-[[weatherbox::dashboard_v2::weatherboxes::start |Weatherboxes Page]] \\
 === Dashboard Meeting Notes ===
 ** Spring 2020 **\\
+May \\
+[[UST: Meeting Minutes May 11 - 15]]\\
+[[UST: Meeting Minutes May 4 - 8]]\\
+April \\
+[[UST: Meeting Minutes Apr. 27 - May 1]]\\
+[[UST: Meeting Minutes Apr. 20 - 24]]\\
+[[UST: Meeting Minutes Apr. 13 - 17]]\\
+[[UST: Meeting Minutes Apr. 6 - 10]]\\
+[[UST: Meeting Minutes Mar. 30 - Apr. 3]]\\
+March\\
+[[UST: Meeting Minutes Mar. 23 - 27]]\\
+[[UST: Meeting Minutes Mar. 13]]\\
+[[UST: Meeting Minutes Mar. 11]]\\
+[[UST: Meeting Minutes Mar. 9]]\\
+[[UST: Meeting Minutes Mar. 6]]\\
+[[UST: Meeting Minutes Mar. 4]]\\
+[[UST: Meeting Minutes Mar. 2]]\\
+February \\
+[[UST: Meeting Minutes Feb. 28]]\\
 [[UST: Meeting Minutes Feb. 24]]\\
 [[UST: Meeting Minutes Feb. 21]]\\
@@ Line 65: / Line 85: @@
 ----
 ===== Dashboard Deployment & Development =====
-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.
+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 the documentation on the wiki.
 === Development Tools ===
@@ Line 76: / Line 96: @@
   * Read and practice [[http://es6-features.org/|ES6 syntax]] in particular
   * Look at the [[https://reactjs.org/tutorial/tutorial.html| React documentation]]
-=== Current SCEL Software Members ===
+  * Understand how to use [[https://www.tutorialspoint.com/git/index.htm|Git]]
+=== Local Deployment ===
+In order to locally deploy this dashboard, you must have access to the SCEL database. Please contact Kenny or firmware team to create an account. In addition, you must have access to the repository. Once you have granted those accesses, please do the following:
+  - Using Git, clone the repository onto your main desktop in the folder you want to work on the project using <code>git clone https://github.com/scel-hawaii/dashboard_v3_react.git</code>
+  - Install the necessary modules using <code>npm install</code>
+  - Once the installation is complete, connect to the SCEL database server and login with your credentials by replacing the username in <code>ssh [email protected] -p 11144 -L 5432:localhost:5432</code>
+  - Once connected, open another terminal, navigate into the api/models/ folder, and test the API using <code>node index.js</code> You should then be able to see the results come into https://localhost:3001. You can preview the result by looking at https://localhost:3001/apple.
+  - In another terminal, navigate to the project's main folder and run the dashboard application using <code>npm start</code> You should now see the local deployment of the dashboard with processed information coming from the locally-hosted database through the API.
+=== Developing Steps ===
 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
@@ Line 91: / Line 119: @@
   - 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.
-----
-===== Problems/Resolutions =====
-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.
 ----
 ===== Presentations =====
 {{ :weatherbox:dashboard_v3:spring_2020_dashboard_proposal_presentation.pdf | Proposal}}\\
-{{ :weatherbox:dashboard_v2:dashboard_pdr_presentation.pdf | Preliminary Design Review (PDR)}}\\
+{{ :weatherbox:dashboard_v3:spring_2020_dashboard_pdr_presentation.pdf | Preliminary Design Review (PDR)}}\\
-{{ :weatherbox:dashboard_v2:dashboard_cdr_presentation.pdf | Critical Design Review (CDR)}}\\
+{{ :weatherbox:dashboard_v3:spring_2020_dashboard_cdr_presentation.pdf | Critical Design Review (CDR)}}\\
-{{ :weatherbox:dashboard_v2:dashboard_final_presentation.pdf | Final}}\\
+{{ :weatherbox:dashboard_v3:spring_2020_dashboard_final_presentation.pdf | Final}}\\