dwyl / phoenix-ecto-append-only-log-example

📝 A step-by-step example/tutorial showing how to build a Phoenix (Elixir) App where all data is immutable (append only). Precursor to Blockchain, IPFS or Solid!

GNU General Public License v2.0

78 stars 7 forks source link

General Tidy Up ahead of Sharing with Elixir Community! #11

Closed nelsonic closed 5 years ago

nelsonic commented 5 years ago

Finishing tasks in #1 >> sharing the tutorial on public forums/newsletters will come after Dan's update to the "How?" section, see: https://github.com/dwyl/phoenix-ecto-append-only-log-example/pull/11#issuecomment-430554785
[x] Displaying "badges" in Readme #3
[x] Add notes from "questions" #5
Increasing test coverage #10 >> We will solve this once "How?" section complete: https://github.com/dwyl/phoenix-ecto-append-only-log-example/pull/11#issuecomment-430554785

@iteles please review the copy changes ahead of @Danwhy's update to the "How?" section. Thanks! ✨

codecov[bot] commented 5 years ago

Codecov Report

Merging #11 into master will increase coverage by 2.33%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #11      +/-   ##
==========================================
+ Coverage   56.75%   59.09%   +2.33%     
==========================================
  Files          11        8       -3     
  Lines          37       22      -15     
==========================================
- Hits           21       13       -8     
+ Misses         16        9       -7

Impacted Files	Coverage Δ
test/support/channel_case.ex
test/support/conn_case.ex
test/support/data_case.ex

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3eb130e...81162d4. Read the comment docs.

Danwhy commented 5 years ago

@nelsonic There are a few things/improvements I came across when implementing https://github.com/dwyl/alog/ that I'd like to add to this guide before we share it, as well as some answers to @RobStallion's questions in an 'FAQ'. I won't have a chance to do it before Friday though

nelsonic commented 5 years ago

@Danwhy sweet! 🍭 I will not alter the "How?" (implementation) Section so you can do your thing on Friday afternoon or Monday morning. 📆

nelsonic commented 5 years ago

@iteles in light of @Danwhy's learnings while creating https://github.com/dwyl/alog the "How?" section of this example/tutorial will be updated independently of this PR.

Please read the first few questions of the README.md of this branch: https://github.com/dwyl/phoenix-ecto-append-only-log-example/tree/tidy-up-for-publication-issue%231

If you are happy with the ("beginners' mind" focussed) changes, please merge so that Dan can work from master. Thanks! ✨