Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README with config files #10

Merged
merged 2 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .idea/runConfigurations/development.xml

This file was deleted.

7 changes: 0 additions & 7 deletions .idea/runConfigurations/production.xml

This file was deleted.

7 changes: 0 additions & 7 deletions .idea/runConfigurations/staging.xml

This file was deleted.

19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,28 @@ A full-stack application to show Apple PassKit functionality.

## Getting Started 🚀

### Configuration Files 📁

This project has a VSCode configuration under `.vscode/launch.json` that expects an env.json file at the root of the project.

```json
{
"TEAM_IDENTIFIER": "MY_TEAM_IDENTIFIER",
"PASS_TYPE_IDENTIFIER": "com.my_company.my_pass_app"
}
```

And requires the `certificate.pem` and `private_key.pem` files to be present in this directory `api/data/`. You can check the PassKit Signing documentation [here](https://github.com/ueman/passkit/blob/master/passkit/SIGNING.md) to learn more about how to generate these files.

### Flavors 🍦

This project contains 3 flavors:

- development
- staging
- production

To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
To run the desired flavor either use the launch configuration in VSCode or use the following commands:

```sh
# Development
Expand All @@ -31,7 +46,7 @@ $ flutter run --flavor staging --target lib/main_staging.dart
$ flutter run --flavor production --target lib/main_production.dart
```

_\*Pass App works on iOS, Android, Web, and Windows._
_\*Pass App works on iOS only, due to Apple Wallet integrations._

---

Expand Down
Loading