-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Updating README with section for each frontend and backend. #1
- Loading branch information
1 parent
400acfd
commit 5c56c1f
Showing
3 changed files
with
85 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |