Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Enhance README.md with Context, Screenshots and Conclusion #3

Closed
5 tasks done
nelsonic opened this issue Jun 17, 2022 · 11 comments
Closed
5 tasks done

Chore: Enhance README.md with Context, Screenshots and Conclusion #3

nelsonic opened this issue Jun 17, 2022 · 11 comments
Labels
chore a tedious but necessary task often paying technical debt discuss Share your constructive thoughts on how to make progress with this issue documentation Improvements or additions to documentation enhancement New feature or request priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished starter A beginner-friendly issue that is a good starting point for a new person T5m Quick tasks that take 5 mins or less. See: GTD 2 min rule.

Comments

@nelsonic
Copy link
Member

nelsonic commented Jun 17, 2022

At present, the README.md shows basic setup of the App. 🎉

The barebones stopwatch works: https://liveview-stopwatch.fly.dev/ 🚀

image

But does not take advantage of the "killer feature" of LiveView ... 🔄
i.e. "free" RealTime Sync between clients! 🤯 😍

Todo

Add:

@nelsonic nelsonic added documentation Improvements or additions to documentation enhancement New feature or request discuss Share your constructive thoughts on how to make progress with this issue T1h Time Estimate 1 Hour priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished chore a tedious but necessary task often paying technical debt starter A beginner-friendly issue that is a good starting point for a new person labels Jun 17, 2022
@nelsonic
Copy link
Member Author

@SimonLab do you want to take a look at this or should I make an attempt while you
review the PRs assigned to you: https://github.com/pulls?q=is%3Aopen+is%3Apr+assignee%3ASimonLab ?

https://github.com/orgs/dwyl/projects/14?fullscreen=true
image

@nelsonic
Copy link
Member Author

Gonna time-box T1h on this and see how far I get. ⏳
Keen to have at least the RealTime Sync between clients and a Screenshot in the README.md. 💭
Will create a PR even if I don't finish it now it will be a starting point. 👍

@nelsonic nelsonic self-assigned this Jun 17, 2022
@nelsonic nelsonic added the in-progress An issue or pull request that is being worked on by the assigned person label Jun 17, 2022
nelsonic added a commit that referenced this issue Jun 17, 2022
nelsonic added a commit that referenced this issue Jun 17, 2022
@SimonLab
Copy link
Member

SimonLab commented Jun 17, 2022

Do you have a specific implementation in mind for RealTime Sync @nelsonic ?
We could start by using PubSub and add persistence with Postges (the application has been created with --no-ecto, we could add Ecto back to the project but I'm not sure if it is worth it for this stopwatch) or ets if we don't want to persist the timers in database.

@nelsonic
Copy link
Member Author

@SimonLab good question.
I was thinking just the same methodology we used in the Counter App: dwyl/phoenix-liveview-counter-tutorial
but just the PubSub part, I don't even think we need persistence right now.
That's the kind of thing we can just describe in the "potential enhancements" section.

@SimonLab
Copy link
Member

Sounds good. I would even maybe use Agent instead of GenServer as the state of the Timer is simple.
Agree to delay persistence for a future feature.

@nelsonic
Copy link
Member Author

nelsonic commented Jun 17, 2022

@SimonLab yeah, an Agent is a good option.
Provided we can send the:

  • start and stop time
  • signals/actions (start|stop|reset)

over the socket we have a collaborative stopwatch.

Not saying I don't want to have persistence.
In fact if we can add auth and history it would be amaze.
But one thing at a time. 👍

@SimonLab
Copy link
Member

SimonLab commented Jun 17, 2022

stopwatch sync PR ready: #5
I'll add the reset button and logic on a next PR added to the same PR as the code is not too big for this feature

nelsonic added a commit that referenced this issue Jun 18, 2022
nelsonic added a commit that referenced this issue Jun 18, 2022
nelsonic added a commit that referenced this issue Jun 18, 2022
@nelsonic
Copy link
Member Author

stopwatch

@nelsonic
Copy link
Member Author

@SimonLab please see: #4 🙏 Thanks! ☀️ [when you are back at your desk on Monday!]

@nelsonic nelsonic assigned SimonLab and unassigned nelsonic Jun 18, 2022
@nelsonic nelsonic added awaiting-review An issue or pull request that needs to be reviewed and removed in-progress An issue or pull request that is being worked on by the assigned person labels Jun 18, 2022
nelsonic added a commit that referenced this issue Jun 18, 2022
@nelsonic nelsonic added T5m Quick tasks that take 5 mins or less. See: GTD 2 min rule. and removed T1h Time Estimate 1 Hour labels Jun 18, 2022
SimonLab added a commit that referenced this issue Jun 20, 2022
@SimonLab
Copy link
Member

Readme is up to date, and sync is now working, closing

@SimonLab SimonLab removed the awaiting-review An issue or pull request that needs to be reviewed label Jun 20, 2022
@SimonLab SimonLab removed their assignment Jun 20, 2022
@nelsonic
Copy link
Member Author

Thanks @SimonLab 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore a tedious but necessary task often paying technical debt discuss Share your constructive thoughts on how to make progress with this issue documentation Improvements or additions to documentation enhancement New feature or request priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished starter A beginner-friendly issue that is a good starting point for a new person T5m Quick tasks that take 5 mins or less. See: GTD 2 min rule.
Projects
None yet
Development

No branches or pull requests

2 participants