https://github.com/spydon/badge_hack

This is a skeleton repository for the Flutter & Friends' Badge Hack
https://github.com/spydon/badge_hack

Last synced: 13 days ago
JSON representation

This is a skeleton repository for the Flutter & Friends' Badge Hack

• Host: GitHub
• URL: https://github.com/spydon/badge_hack
• Owner: spydon
• License: mit
• Created: 2024-08-24T11:12:17.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-03T12:12:53.000Z (5 months ago)
• Last Synced: 2025-01-03T00:11:27.879Z (20 days ago)
• Language: Dart
• Size: 72.3 KB
• Stars: 1
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# badge_hack

Welcome to the Flutter & Friends 2024 badge hack!

Use your imagination to hack around with the provided NFC tags,

creating novel apps and games or expanding on existing ones.

Write to them, read from them, learn from them, and more.

The sky is the limit to what you'll be able to create with

your new friends from Flutter & Friends!

If you need extra NFC tags for your application, let us know!

**Find some inspiration:**

[![Find some inspiration](https://i.ytimg.com/vi/3cqamQYBiSA/sddefault.jpg)](https://www.youtube.com/watch?v=3cqamQYBiSA)

## Setup

Feel free to clone, copy, or download this repo for a basic setup

with some of the permissions already set up.

### Packages

Choose one of the following packages, or others if you know of one.

This template is set up with `package:nfc_manager`.

- `package:nfc_manager`

  - [Package](https://pub.dev/packages/nfc_manager)

  - [API documentation](https://pub.dev/documentation/nfc_manager)

  - [Example](https://github.com/okadan/flutter-nfc-manager/blob/master/example/lib/main.dart)

  - [Tutorial](https://medium.com/@antonioneus/reading-and-writing-nfc-using-nfcmanager-in-flutter-dc5420991967)

- `package:flutter_nfc_kit`

  - [Package](https://pub.dev/packages/flutter_nfc_kit)

  - [API documentation](https://pub.dev/documentation/flutter_nfc_kit)

  - [Example](https://github.com/nfcim/flutter_nfc_kit/blob/master/example/lib/main.dart)

### Permissions

NFC reading and writing requires permission setup depending on the platform.

#### Android

Add `android.permission.NFC` to the `app/src/main/AndroidManifest.xml` file:

```xml

```

#### iOS

iOS 13 or later is required as well as the following setup.

> [!IMPORTANT]  

> To use NFC on a physical iOS device, a paid developer account is required.

- Add the `com.apple.developer.nfc.readersession.formats` entitlement

  to your entitlements (`/ios/Runner/Runner.entitlements`, `/ios/Runner/RunnerDebug.entitlements`):

  ```xml

  com.apple.developer.nfc.readersession.formats

  

      TAG

  

  ```

  

  Note that this entitlement was already added to this template.

- Add a `NFCReaderUsageDescription` to

  your `Info.plist` file (`/ios/Runner/Info.plist`):

  ```xml

  NFCReaderUsageDescription

  Read from NFC Tags

  ```

  Note that this description was already added to this template.

- **Important:** Add the "Near Field Communication Tag Reading" capability in XCode.

  1. Open your `Runner.xcodeproj` in Xcode and click on: `Signing & Capabilities`.

  2. Click on/use the `+ Capability` button.

  3. Add the "Near Field Communication Tag Reading" capability.

  4. Make sure you're using a paid developer account as

     iOS requires it for using NFC.

  

## Submission

Your app can be as big or small as you like.

Let us know when you're happy with your creation!