avo-hq/avo

Auto-Refresh for Resources

Open

#3,232 opened on Sep 10, 2024

View on GitHub
 (12 comments) (0 reactions) (0 assignees)Ruby (1,778 stars) (308 forks)user submission
FeatureHelp wantedJavascript

Description

Feature

It would be beneficial to have an auto-refresh option for resources in Avo, such as refresh_every on the cards where real-time updates are critical for users to track changes without manually refreshing the page.

Current workarounds

I found the refresh_every on Cards but there is no built-in way to achieve this at the moment on resources. Users need to refresh the page manually to see updated data.

Screenshots or screen recordings

image Screenshot from 2024-09-10 13-13-50

Additional context

Auto-refresh features are commonly seen in dashboards like those in logistics or tracking systems where real-time updates are essential. Examples can be seen in other admin panel frameworks or platforms that deal with constantly changing data like order statuses in e-commerce systems.

Contributor guide

Tech stack
rubyrailsjavascript
Domain
backendfull stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Ruby on Rails basicsUnderstanding of Avo resource architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
To implement auto refresh on resources, examine how `refresh every` works on Cards in the Avo codebase. Extend that mechanism to Resource views by adding a configuration option and polling logic. Review issue comments for design suggestions and check the Avo documentation for resource configuration files (e.g., app/avo/resources/). Also explore existing JavaScript that handles real time updates to integrate with backend polling.