Skip to content

Commit

Permalink
add outline of standard questions/answers to README.md #1
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonic committed Mar 7, 2020
1 parent cc7ad48 commit b41bb25
Show file tree
Hide file tree
Showing 43 changed files with 70 additions and 12,178 deletions.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,50 @@
[![codecov.io](https://img.shields.io/codecov/c/github/dwyl/phoenix-liveview-counter-tutorial/master.svg?style=flat-square)](http://codecov.io/github/dwyl/phoenix-liveview-counter-tutorial?branch=master)
-->

## Why? 🤷

There are several example apps on GitHub using Phoenix LiveView
but none include are step-by-step instructions
a _complete_ beginner can follow.
This repository is the **_complete beginner's_ tutorial**
we _wish_ we had when **learning LiveView**
and the one _you_ have been looking for!

> Chris McCord the creator of Phoenix and LiveView has an example:
[https://github.com/chrismccord/phoenix_live_view_example](https://github.com/chrismccord/phoenix_live_view_example/tree/e3966aca18f7d8f4da84d197e3ee22af4050fd5e)
At the time of writing, we feel that it is not very beginner-friendly.
Only the default "_start your Phoenix server_" instructions are included,
and the dependencies have
[diverged](https://github.com/chrismccord/phoenix_live_view_example/issues/56)
so the exampled does not _run_.
We totally understand that Chris is focussing _building_
Phoenix and LiveView so we decided to fill in the gaps
and write this tutorial.



## What? 💭

A _complete beginners_ tutorial for building
the most basic possible Phoenix LiveView App
with no prior experience necessary.



## Who? 👤

This tutorial is aimed at people who have
never built _anything_ in Phoenix or LiveView.





## How? 💻





To start your Phoenix server:

Expand All @@ -21,3 +65,29 @@ Ready to run in production? Please [check our deployment guides](https://hexdocs
* Docs: https://hexdocs.pm/phoenix
* Mailing list: http://groups.google.com/group/phoenix-talk
* Source: https://github.com/phoenixframework/phoenix




## Credits 🙌

All credit for this tutorial goes to Dennis Beatty
[@dnsbty](https://github.com/dnsbty)
for his superb post:
https://dennisbeatty.com/2019/03/19/how-to-create-a-counter-with-phoenix-live-view.html
and corresponding video: https://youtu.be/2bipVjOcvdI

[![dennisbeatty-counter-video](https://user-images.githubusercontent.com/194400/76142652-953e2f80-6067-11ea-95f7-1efdad619b2f.png)](https://youtu.be/2bipVjOcvdI)

We recommend _everyone_ learning `Elixir`
subscribe to his YouTube channel and watch _all_ his videos
as they are a _superb_ resource.

The 3 key differences
between this tutorial and Dennis' original post are:

1. **_Complete_ code** commit (snapshot) at the end of each section.
(_not just snippets of code_)
2. **_Latest_ Phoenix, Elixir and LiveView** versions.
3. ***Test Driven Development*** is followed so _complete_ beginners
can see how easy it is to write reliable code in a basic example.
5 changes: 0 additions & 5 deletions assets/.babelrc

This file was deleted.

4 changes: 0 additions & 4 deletions assets/css/app.css

This file was deleted.

134 changes: 0 additions & 134 deletions assets/css/phoenix.css

This file was deleted.

21 changes: 0 additions & 21 deletions assets/js/app.js

This file was deleted.

63 changes: 0 additions & 63 deletions assets/js/socket.js

This file was deleted.

Loading

0 comments on commit b41bb25

Please sign in to comment.