mirror of
https://github.com/flutter/holobooth.git
synced 2025-05-17 05:16:00 +08:00
chore: readme and metadata updates (#408)
This commit is contained in:
Kirpal Demian
36
README.md
36
README.md
@ -1,15 +1,15 @@
|
||||
# Holobooth
|
||||
|
||||
[![Holobooth Header][logo]][photo_booth_link]
|
||||
[![Holobooth Header][logo]][holobooth_link]
|
||||
|
||||
[![io_photobooth][build_status_badge]][workflow_link]
|
||||
[![build status][build_status_badge]][workflow_link]
|
||||
![coverage][coverage_badge]
|
||||
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
|
||||
[![License: MIT][license_badge]][license_link]
|
||||
|
||||
A Holobooth built with [Flutter][flutter_link] and [Firebase][firebase_link] for [Google I/O 2021][google_io_link].
|
||||
A Holobooth built with [Flutter][flutter_link] and [Firebase][firebase_link] for [Flutter Forward][flutter_forward_link].
|
||||
|
||||
[Try it now][photo_booth_link] and [learn about how it's made][blog_link].
|
||||
[Try it now][holobooth_link] and [learn about how it's made][blog_link].
|
||||
|
||||
*Built by [Very Good Ventures][very_good_ventures_link] in partnership with Google*
|
||||
|
||||
@ -161,9 +161,9 @@ mason make bloc
|
||||
> Mason support for Visual Studio Code can be found [here](https://marketplace.visualstudio.com/items?itemName=FelixAngelov.mason).
|
||||
|
||||
---
|
||||
## Debug web app on iphone
|
||||
## Debug web app on iPhone
|
||||
|
||||
To debug the web app on the iphone, we need to run it as https, because without that, the iphone won't let us use the camera. We need to configure safari to listen for logs from the iphone.
|
||||
To debug the web app on the iPhone, we need to run it as https, because without that, the iPhone won't let us use the camera. We also need to configure Safari to use the phone's developer tools.
|
||||
|
||||
### Configure https server
|
||||
|
||||
@ -205,31 +205,31 @@ http-server --ssl --cert ~/.localhost-ssl/localhost.crt --key ~/.localhost-ssl/l
|
||||
|
||||
1. On Mac
|
||||
|
||||
```sh
|
||||
```
|
||||
Open Safari > Preferences > Advanced > enable "Show Develop menu in menu bar"
|
||||
```
|
||||
|
||||
2. On iPhone
|
||||
|
||||
```sh
|
||||
```
|
||||
Open Settings > Safari > Advanced > enable "Web Inspector"
|
||||
```
|
||||
|
||||
3. Connect your device to your Mac using a USB cable.
|
||||
|
||||
4. Open Safari on iphone and enter server adress, for example https://192.168.1.1:8080
|
||||
4. Open Safari on iOS and enter the server address, for example https://192.168.1.1:8080
|
||||
|
||||
5. On Mac
|
||||
|
||||
```sh
|
||||
Safari > Develop > Find "YourPhoneName" > select the Safari session entered earlier, for example 192.168.1.1
|
||||
```
|
||||
Safari > Develop > Find "YourPhoneName" > Select the URL entered earlier, for example 192.168.1.1
|
||||
```
|
||||
|
||||
## Assets generation
|
||||
|
||||
We rely on fluttergen to generate the assets. Everytime a new asset folder is needed we should
|
||||
We rely on fluttergen to generate the assets. Everytime a new asset folder is added, we should:
|
||||
|
||||
1. Adding the folder to the pubspec.yaml
|
||||
1. Add the folder to the pubspec.yaml
|
||||
```
|
||||
flutter:
|
||||
assets:
|
||||
@ -240,12 +240,14 @@ flutter:
|
||||
```
|
||||
|
||||
2. Run `fluttergen` on the console
|
||||
3. Use your asset
|
||||
3. Use the asset
|
||||
|
||||
```dart
|
||||
Assets.nameOfTheFolder.nameOfTheAsset
|
||||
```
|
||||
|
||||
> Note: Step one can be skipped if the folder is already added to the pubspec.yaml.
|
||||
|
||||
### Test Assets LICENSE
|
||||
|
||||
In order to properly test the face recognition feature, this project uses free photos downloaded from Unsplash
|
||||
@ -257,18 +259,18 @@ and the links from each individual image on the LICENSE file under that same fol
|
||||
---
|
||||
|
||||
|
||||
[build_status_badge]: https://github.com/flutter/photobooth/actions/workflows/main.yaml/badge.svg
|
||||
[build_status_badge]: https://github.com/flutter/holobooth/actions/workflows/main.yaml/badge.svg
|
||||
[coverage_badge]: coverage_badge.svg
|
||||
[firebase_link]: https://firebase.google.com/
|
||||
[flutter_link]: https://flutter.dev
|
||||
[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html
|
||||
[google_io_link]: https://events.google.com/io/
|
||||
[flutter_forward_link]: https://flutter.dev/events/flutter-forward
|
||||
[blog_link]: https://medium.com/flutter/how-its-made-i-o-photo-booth-3b8355d35883
|
||||
[internationalization_link]: https://flutter.dev/docs/development/accessibility-and-localization/internationalization
|
||||
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
|
||||
[license_link]: https://opensource.org/licenses/MIT
|
||||
[logo]: art/header.png
|
||||
[photo_booth_link]: https://photobooth.flutter.dev
|
||||
[holobooth_link]: https://holobooth.flutter.dev
|
||||
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
|
||||
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
|
||||
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli
|
||||
|
||||
BIN
art/header.png
BIN
art/header.png
Binary file not shown.
|
Before Width: | Height: | Size: 904 KiB After Width: | Height: | Size: 1.3 MiB |
@ -5,17 +5,17 @@
|
||||
|
||||
<meta charset="UTF-8" />
|
||||
<meta content="IE=Edge" http-equiv="X-UA-Compatible" />
|
||||
<meta name="description" content="Take a photo in the Holobooth with your favorite Google Developer Mascots! Built with Flutter & Firebase for Google I/O 2021.">
|
||||
<meta name="description" content="Take a photo in the Holobooth with your favorite Google Developer Mascots! Built with Flutter & Firebase for Flutter Forward.">
|
||||
|
||||
<meta property="og:description" content="Take a photo in the Holobooth with your favorite Google Developer Mascots! Built with Flutter & Firebase for Google I/O 2021.">
|
||||
<meta property="og:description" content="Take a photo in the Holobooth with your favorite Google Developer Mascots! Built with Flutter & Firebase for Flutter Forward.">
|
||||
<meta property="og:title" content="Google Holobooth">
|
||||
<meta property="og:url" content="https://photobooth.flutter.dev">
|
||||
<meta property="og:url" content="https://holobooth.flutter.dev">
|
||||
<meta property="og:image" content="https://firebasestorage.googleapis.com/v0/b/io-photobooth-dev.appspot.com/o/public%2Fphotobooth-metadata-image.jpeg?alt=media">
|
||||
|
||||
<meta name="twitter:text:title" content="Google Holobooth">
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:title" content="Google Holobooth">
|
||||
<meta name="twitter:description" content="Take a photo in the Holobooth with your favorite Google Developer Mascots! Built with Flutter & Firebase for Google I/O 2021.">
|
||||
<meta name="twitter:description" content="Take a photo in the Holobooth with your favorite Google Developer Mascots! Built with Flutter & Firebase for Flutter Forward.">
|
||||
<meta name="twitter:image" content="https://firebasestorage.googleapis.com/v0/b/io-photobooth-dev.appspot.com/o/public%2Fphotobooth-metadata-image.jpeg?alt=media">
|
||||
|
||||
<!-- iOS meta tags & icons -->
|
||||
|
||||
Reference in New Issue
Block a user