EPIC: Update MVP App to Latest Phoenix with auth_plug

[nelsonic]

This project is a bit out-of-date.
Let's fix that and add @dependabot to keep it up-to-date!

Todo

• Create ERD EPIC: Update MVP App to Latest Phoenix with auth_plug #89 (comment)
• Map out all existing functions/functionality [read through the docs + update!] EPIC: Update MVP App to Latest Phoenix with auth_plug #89 (comment)
• Create a branch
• Nuke all the code! 🙊
• Create a new [email protected] project 🆕
• Re-create the schemas as per the ERD
  • Simplify them along the way!
• Add auth_plug so we leverage auth from the start. Add auth_plug #104
  • auth is not required to create items. i.e optional.
• Re-create basic MVP functionality using LiveView instead of MVC. #100
  • create an item using basic interface
  • items are automatically added to a single list (separate lists can follow later)
  • all items are considered to be tasks for now and thus have a timer (start) button next to them in the UI/UX
  • Render counting timer using Alpine.js Render Counting Timer in UI with Alpine.js #99
  • Accumulate timers Accumulate timers #103
  • Edit timer.text Edit item.text #102
  • Add icons to buttons Add UI Icons to Buttons #101
  • sync to connected devices
• Android/Apple Shortcut icons (for add to home screen) Mobile Device Shortcut icon #111
• Create PR! PR: Simplify MVP + Update to Phoenix 1.6 #89 #90
• Deploy to Fly.io (fast!) Deploy MVP to Fly.io! 🚀  #109 🚀
• Rename timer.end to timer.stop: Chore: Rename timer.end to timer.stop  #114
• Implement upsert_people/1 function upsert_person/1 #115 to create or update a person record. c77d43a
• DELETE people schema/table from the project! Remove people table completely? ✂️  #118
• Update the README.md
  • Add brief section on MVPs MVP how to #91
• Assign to Simon
• Iterate!! > GOTO: Feat: View Archived items #119

[nelsonic]

ERD of existing MVP on main branch: [click the image to enlarge]

This ERD covers the "Single Player Mode" described in the /dwyl/product-roadmap#1-single-player
i.e. there is no concept of sharing, permissions or collaboration.

Do we want to add the complexity of "Multi-Player" to the MVP?
I know that personally I want to be able to share an item with my co-worker/family-member/friend etc.
But the question is: should we be thinking about that in MVP or only in a subsequent iteration? 💭

[nelsonic]

I think I answered my own question in the Product Roadmap link above. 💭
Specifically, the App must be immediately useful to the individual person. 👩‍💻
So that's what I'm (we're) going to focus on first. 🏁

And then we can add the concept of groups of (one ore more) people later. 👪

[nelsonic]

For reference, at the time of writing, visiting: https://dwylapp.herokuapp.com I see:

When I authenticate with my Google Account, I see:
https://dwylapp.herokuapp.com/people/info

And when I click on "capture" I see: https://dwylapp.herokuapp.com/capture/new

When I submit I'm shown: https://dwylapp.herokuapp.com/categorise

When visiting the list: https://dwylapp.herokuapp.com/items

This item created by a random person: https://dwylapp.herokuapp.com/items/233

Summarises it well. 💭

[nelsonic]

Quick walkthrough of the "User Journey" through using the current version of the App,
with reference to the ERD:

This version does not allow people to create items without being authenticated.
So that's the first step as noted in the screenshots above.

Once authenticated the person creates an item.
The item can be edited/updated.
That's it.

At present the schema is there for lists and list_items but
also the schema is there for timers but the functionality/UI to start|stop a timer is not #7
tags and status tables are also present but there is no UI to manage them.

So the MVP as it stands is very incomplete.
Let's fix that!

[nelsonic]

Dependencies we want to bring with us:

  # Easily Encrypt Senstive Data: github.com/dwyl/fields
  {:fields, "~> 2.7.1"},
  # Auth with ONE Environment Variable: github.com/dwyl/auth_plug
  {:auth_plug, "~> 1.2.3"},
  # Useful functions: https://github.com/dwyl/useful
  {:useful, "~> 0.1.0"},

  # create docs on localhost by running "mix docs"
  {:ex_doc, "~> 0.22.6", only: :dev, runtime: false},
  # track test coverage
  {:excoveralls, "~> 0.13.2", only: [:test, :dev]},
  # git pre-commit hook runs tests before allowing commits
  {:pre_commit, "~> 0.3.4"},
  {:credo, "~> 1.1.0", only: [:dev, :test], runtime: false},

https://github.com/dwyl/app-mvp-phoenix/blob/745c7e87b42f07888edfe7f4527998b827e6a6e3/mix.exs#L54-L67

Note: all of these are way out-of-date, this is just for reference.

[nelsonic]

Also want to keep these settings

test_coverage: [tool: ExCoveralls],
preferred_cli_env: [
  c: :test,
  coveralls: :test,
  "coveralls.json": :test,
  "coveralls.html": :test,
  t: :test
]

and aliases:

c: ["coveralls.html"],
s: ["phx.server"],
t: ["test"],

[nelsonic]

Coverage hasn't dropped, it's just not being accurately recorded on my Mac ... 🙄

[nelsonic]

@SimonLab I've finished updating
the README.md: https://github.com/dwyl/app-mvp/blob/phoenix-1.6-2022-refresh-issue-%2389/README.md 📜
and BUILDIT.md dev log: https://github.com/dwyl/app-mvp/blob/phoenix-1.6-2022-refresh-issue-%2389/BUILDIT.md 🧑‍💻

Please take a look and give feedback when you can. 🙏
Thanks again for your patience on this. 👍

[nelsonic]

Final GIF:

[nelsonic]

After removing people table had to run:

ALTER TABLE items 
RENAME COLUMN status_code TO status;

DROP INDEX items_person_id_index;
ALTER TABLE items DROP CONSTRAINT items_person_id_fkey;

ALTER TABLE timers DROP CONSTRAINT timers_person_id_fkey;

DROP TABLE people;

[nelsonic]

@SimonLab your suggested fixes merged into the PR #90 ✅
Please review again when you can. 🙏

[SimonLab]

PR #90 merged, we can start the last checkbox item: iterate

[nelsonic]

Thanks again @SimonLab 🎉