Skip to content

Commit

Permalink
馃摑 Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Friese <[email protected]>
  • Loading branch information
peterfriese committed Apr 29, 2022
1 parent 18c1f49 commit 09b97ea
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
<br />
<p align="center">
<a href="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/peterfriese/MakeItSo">
<img src="assets/logo/MakeItSo.png" alt="Logo">
<img src="assets/hero/repo-hero.png" alt="Logo">
</a>

<h3 align="center">Make It So - Again!</h3>
<h1 align="center">Make It So - Again!</h1>

<p align="center">
This is the source code for <i>Make It So</i>, a sample app that demonstrates how to use Firebase in a SwiftUI app that runs on all (most) of Apple's platforms.
<br />
<a href="https://github.com/peterfriese/MakeItSo"><strong>Explore the docs 禄</strong></a>
<a href="https://twitter.com/peterfriese/status/1453467058302291975"><strong>Follow along on Twitter as I code the app 禄</strong></a>
<br />
<br />
<a href="https://github.com/peterfriese/MakeItSo/issues">Report Bug</a>
Expand All @@ -28,13 +28,21 @@
</p>
</p>

## Where is the previous version?
If you are interested in the previous version, you can find it in the [`previous`](https://github.com/peterfriese/MakeItSo/tree/previous) branch.
# Getting started

## Why a complete rewrite?
Because both SwiftUI and Firebase have evolved quite a bit since I implemented the original version, and I wanted to create an up-to-date version without having to carry the baggage of the legacy version.
This app requires a Firebase project, which you can create at no cost using the [Firebase Console](https://console.firebase.google.com). Here are the steps. For a more detailed description of how to add Firebase to an iOS project, refer to the [official Firebase docs for iOS and Apple's other platforms](https://firebase.google.com/docs/ios/setup).

## About The Project
1. Clone the repo
1. Create a Firebase project
2. Create a Cloud Firestore database in the new Firebase project ([link](https://console.firebase.google.com/project/_/firestore/))
2. Enable Anonymous Authentication ([link](https://console.firebase.google.com/project/_/authentication/providers))
1. Register the iOS app in the Firebase project
1. Download the `GoogleService-Info.plist` file to the `code/frontend/Configuration/Firebase/Development` folder
1. Open `MakeItSo.xcodeproj` in Xcode
1. Select the `MakeItSo (iOS) DEV` target
1. Run the app

# About the project


<!-- LICENSE -->
Expand All @@ -49,7 +57,6 @@ This is not an official Google product.

<!-- CONTACT -->
## Contact

Peter Friese - [@peterfriese](https://twitter.com/peterfriese)

Project Link: [https://github.com/peterfriese/MakeItSo](https://github.com/peterfriese/MakeItSo)
Expand All @@ -58,14 +65,14 @@ Project Link: [https://github.com/peterfriese/MakeItSo](https://github.com/peter

## Acknowledgements

* The application icon is based on [Check](https://thenounproject.com/term/check/1905028/) by [Robert Won](https://thenounproject.com/robertwon/) from the [Noun Project](https://thenounproject.com/)
The application icon is based on [Check](https://thenounproject.com/term/check/1905028/) by [Robert Won](https://thenounproject.com/robertwon/) from the [Noun Project](https://thenounproject.com/)

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[xcode-shield]: https://img.shields.io/badge/xcode-v11.4.1-blue
[xcode-shield]: https://img.shields.io/badge/xcode-v13.3.1-blue
[xcode-url]: https://developer.apple.com/xcode/

[swift-shield]: https://img.shields.io/badge/swift-v5.2-%23fe4b2d
[swift-shield]: https://img.shields.io/badge/swift-v5.5-%23fe4b2d
[swift-url]: https://swift.org/

[contributors-shield]: https://img.shields.io/github/contributors/peterfriese/MakeItSo.svg?style=flat-square
Expand Down
Binary file added assets/hero/MakeItSo-Hero.key
Binary file not shown.
Binary file added assets/hero/MakeItSo-Hero.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/hero/MakeItSo-Hero.rotato
Binary file not shown.
Binary file added assets/hero/repo-hero.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 09b97ea

Please sign in to comment.