Giter Club home page Giter Club logo

esid's Introduction

Hi there ๐Ÿ‘‹

esid's People

Contributors

annawendler avatar dependabot[bot] avatar jonasgilg avatar kerembalci111 avatar luca-spataro avatar lucaspataro avatar mknaranja avatar nxxr avatar pawankaur avatar qacwnfq avatar selmadm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

esid's Issues

Select Project Template

The Project Template should set up the Project and ideally create a project including the libraries from issue #2.

It should also add Typescript support out of the box.

Upgrade to amCharts 5

amCharts has a new major release. The API has changed quite significantly, but it has some major improvements, which are relevant for us:

  • New rendering pipeline which promises a significant performance improvement
  • Fast data processing
  • React support out of the box
  • Theming
  • Accessibility
  • Build with TypeScript

Related Issues

Add README

  • Project Overview
  • Screenshots
  • How to build
  • How to contribute
  • Code of Conduct

Add Template for Pull Requests

Add a template for PRs that enhances the software quality. It should contain:

  • Check Formatting
  • Check Best Practices
  • Check Tests and Coverage
  • Check Documentation

@lucaspataro do you have anything to add?

Improve the heat legend layout

  • add customizable multi-color gradient for heat Legend
  • set heat legend to accept single color gradients as per the design documents
  • add editor for custom heat legends
    • Mockup Example:
      HeatLegendEditor

[Epic]: CompartmentFilters

Related Issues:


In the future, with models with many states of "infected" like "infected vaccinated" or "infected unvaccinated", aggregation of compartments should be possible to be visualized.

The idea is to create a visual editor to aggregate different compartments:
image.png

One idea is to do it similar to this feature in factorio, where you can chain "and" and "or" queries:
li36lr44bbb51.webp

The editor could be opened here:
image.png

Select an OpenSource License

Select an open source license and add it to the project:

  • License selected
  • LICENSE.txt added
  • Additional steps?

[Epic]: DistrictComparison

Related Issues


Tooltip

Improve tooltip with a lens highlighting the selected disctrict and show scenario p25, p50, and p75 of selected scenario (and real value)

  • Tooltip Example:
    LensMockup
    • Lens highlights selected District (might take up too much space)
    • Left gradient shows scenario's p50 (center dot), p25 and p75 (gradient start/end)
    • Right shows tooltip text
    • Border colored depending on selected scenario
    • selected District colored in current real value (?)

Scenario Comparison

Allow scenarios to be compared in the district map

  • display heatmap with relative difference between two scenarios or scenario and real value
  • reduce districts to a node map with colored nodes
    • colored with a heat legend based on the differece between scenarios
    • colored with both scenarios as gradients from p25 to p75
    • Node with borders colored according to scenario and real value in center:
      NodeMockup
    • Node without borders:
      NodeMockup_noBorder

Save the state in localstorage

[x] using redux-persist to save the state of the store to local storage
[ ] fix/figure out errors related to this (the heatlegend component breaks when loading state from localstorage)
[ ] think about breaking edgecases (backend data changed, or something like that)

Add CI

  • Automatic Tests
  • Code Coverage
  • Formatting Checker
  • Linting Checker

Accessibility

Since we are a public organisation we have to fulfil accessibility requirements. We need to create a strategy to meet the requirements. I would suggest we comply to the WCAG standards.

TODOs:

  • choose a standard
  • find out how to help developers meet these standards during development
  • automatically test for these standards using unit and integration tests
  • automatically test for these standards using CI
  • write appropriate developer documentation

Add Libraries

Add the following libraries:

  • React
  • Redux
  • Material UI
  • AmCharts
  • Jest

make the design more responsive

  • create a responsive layout strategy for narrow viewports
  • implement strategy
    • changes do not break existing layout
    • frontend layout for narrow viewports shows no bugs or layout issues

Will probably fix issue #55

  • adjusting the box-sizing property to border-box to include borders and padding may alleviate the problems with the scrollbars showing up

amCharts animated theme created lag

am4core.useTheme(am4themes_animated) in the simulation chart seems to propagate to the district map in the sidebar leading to lag on the hover effect and tooltip.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.