|
1 | 1 | # NativeAppTemplate-Free-Android |
2 | 2 |
|
3 | | -NativeAppTemplate-Free-Android is a modern, comprehensive, and production-ready native Android app with user authentication and [background tag reading](https://developer.android.com/develop/connectivity/nfc/nfc). |
| 3 | +NativeAppTemplate-Free-Android is a modern, comprehensive, and production-ready native Android app with user authentication and a full CRUD example. |
4 | 4 | This Android app is a free version of [NativeAppTemplate-Android (Solo)](https://nativeapptemplate.com/products/android-solo) and [NativeAppTemplate-Android (Team)](https://nativeapptemplate.com/products/android-team). |
5 | 5 |
|
6 | 6 | The iOS version is available here: [NativeAppTemplate-Free-iOS](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS). |
@@ -45,52 +45,7 @@ NativeAppTemplate-Free-Android uses modern Android development tools and practic |
45 | 45 |
|
46 | 46 | ## NFC Tag Operations |
47 | 47 |
|
48 | | -<details> |
49 | | -<summary><strong>How NFC tag writing and background reading works</strong></summary> |
50 | | - |
51 | | -### Overview |
52 | | - |
53 | | - |
54 | | - |
55 | | - |
56 | | - |
57 | | -The app replaces traditional paper tags with NFC tags to efficiently manage walk-in customer waitlists. It writes application-specific information onto your NFC cards (referred to as :red_circle: **Server Tag** and :large_blue_circle: **Customer Tag**). |
58 | | - |
59 | | -**For Customers:** |
60 | | -When a customer scans a :large_blue_circle: **Customer Tag**, they can view the :green_circle: **Number Tags Webpage** (a public webpage) on their mobile browser. This page displays completed Number Tags. |
61 | | - |
62 | | -**For Staff:** |
63 | | -By scanning a :red_circle: **Server Tag** paired with the :large_blue_circle: **Customer Tag**, staff can complete a Number Tag. Completed Number Tags automatically appear on the :green_circle: **Number Tags Webpage** for customer reference. |
64 | | - |
65 | | -### How It Works |
66 | | - |
67 | | - |
68 | | - |
69 | | -1. Write application info to pair **Number Tags** (Server Tag and Customer Tag) or a **Customer QR code**: |
70 | | - - Go to: **Shops > [Shop] > Shop Settings > Manage Number Tags > [Number Tag]**. |
71 | | -2. Scan a **Server Tag** in the **Scan** tab. |
72 | | -3. View the updated **Number Tags** status in the **Shop Detail** screen or on the **Number Tags Webpage** (see Background Tag Reading GIF below). |
73 | | - |
74 | | -### Recommended NFC Tags |
75 | | -For best performance, use **NTAG215 (540 bytes)** tags. |
76 | | -Example: [50pcs NFC Cards Ntag215](https://www.amazon.com/dp/B087FRYY8S) (Amazon USA). |
77 | | - |
78 | | ---- |
79 | | - |
80 | | -### Background Tag Reading |
81 | | - |
82 | | - |
83 | | - |
84 | | -1. Scan a Server Tag. |
85 | | -2. View the updated Number Tags status in the **Shop Detail** screen or on the **Number Tags Webpage**. |
86 | | - |
87 | | -The **Number Tags Webpage** updates in real-time using Rails [Turbo](https://turbo.hotwired.dev). |
88 | | -This functionality is part of the open-source [nativeapptemplateapi](https://github.com/nativeapptemplate/nativeapptemplateapi) backend. |
89 | | - |
90 | | -> **Note:** |
91 | | -> The GIF above shows [MyTurnTag Creator for iOS](https://apps.apple.com/app/myturntag-creator/id1516198303) in action, which may behave slightly differently from **NativeAppTemplate-Free-Android**. |
92 | | -
|
93 | | -</details> |
| 48 | +NFC tag writing and background tag reading were part of v1 and have been removed from the current version. The full NFC implementation remains available in the [`v1-with-nfc`](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android/tree/v1-with-nfc) branch. |
94 | 49 |
|
95 | 50 | ## Not Included in the Free Version |
96 | 51 |
|
@@ -137,7 +92,6 @@ Cleartext HTTP to private IPs is already permitted in debug via `app/src/debug/r |
137 | 92 | ## Blog |
138 | 93 |
|
139 | 94 | - [Key Differences in MVVM Architecture: iOS vs. Android](https://medium.com/@dadachix/key-differences-in-mvvm-architecture-ios-vs-android-e239d30b2ea7) |
140 | | -- [Cross-Platform Background NFC Tag Reading](https://medium.com/@dadachix/cross-platform-background-nfc-tag-reading-8a704f0cb6e9) |
141 | 95 |
|
142 | 96 | ## Contributing |
143 | 97 |
|
|
0 commit comments