Skip to content

Commit

Permalink
feat: Updating README with section for each frontend and backend. #1
Browse files Browse the repository at this point in the history
  • Loading branch information
LuchoTurtle committed Feb 3, 2023
1 parent 400acfd commit 5c56c1f
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 22 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,33 @@ Therefore,
we recommend giving `learn` repositories
above a read before diving into this demo.

Throughout this tutorial,
you will be basically developing
both the **frontend** and the **backend**.
We *recommend* having separate terminal windows
(or Visual Studio windows)
for each one,
as you will be running
the `Phoenix` backend on one
and the `Flutter` client app
on the other.

## I want to run this project! 🏃‍♂️

You might have noticed we have two folders:
- [`app`](./app/),
pertaining to the `Flutter` application.
- [`backend`](./backend/),
pertaining to the `Phoenix` server
that the client `Flutter` app will connect to.

We recommend you opening *two*
different terminal windows
(one for each folder)
and follow the instructions
inside each one to run this project
and see it in action!

## 0. Creating basic `Flutter` app

In this section,
Expand Down
49 changes: 39 additions & 10 deletions app/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,45 @@
# app
# `Flutter` application

A new Flutter project.
Welcome to the `Flutter` client app!

## Getting Started
This app will *connect*
to a `Phoenix` server.
You need to run it first
in the [`./backend`](../backend/)
folder.

This project is a starting point for a Flutter application.
# Pre-requisites 📝

A few resources to get you started if this is your first Flutter project:
To run Flutter,
whether it's on a real device
or on an emulator,
you need to have the
**`Flutter SDK`** installed,
along with `XCode`
and `Android Studio`.

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
This process can take some time.
Therefore, we've already created a guide for you
to help you get through it
and start "fluttering" 🦋
ASAP!

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
https://github.com/dwyl/learn-flutter#install-%EF%B8%8F


# Run it! 🏃‍♂️

If you want to run
this project on an emulator,
follow the steps found in
https://github.com/dwyl/learn-flutter#0-setting-up-a-new-project.

If you are keen on running this
on your own device,
please visit
https://github.com/dwyl/flutter-stopwatch-tutorial/tree/33907b1b01760dd49db85fa97fb84ce4562252ae#giving-it-a-whirl-.

If you've followed the steps correctly
for your own device or emulator,
you should have the `Flutter` app
properly running!
31 changes: 19 additions & 12 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# App
# `Phoenix` Backend

To start your Phoenix server:
Welcome to the `Phoenix` backend server!

* Run `mix setup` to install and setup dependencies
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
# Pre-requisites 📝

Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
To run this backend,
you need to install:
- [`Elixir`](https://elixir-lang.org/install.html)
- [`Phoenix Framework`](https://hexdocs.pm/phoenix/installation.html)

## Learn more
Click on each link to find out
how to install both of these
so you can run this backend locally!

* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix
# Run it! 🏃‍♂️

If this is your first time using it,
follow the next two steps.

* Run `mix setup` to install and setup dependencies.
* Start Phoenix endpoint with `mix phx.server`.

Your backend should be up and running!

0 comments on commit 5c56c1f

Please sign in to comment.