Skip to content

Commit a362d9e

Browse files
authored
docs: remove NFC tag operations (moved to v1-with-nfc branch) (#57)
NFC code was removed from main and preserved in the v1-with-nfc branch. Drop the now-stale NFC content from the docs: - README: replace the NFC Tag Operations section with a pointer to the v1-with-nfc branch, drop background tag reading from the intro tagline, and remove the NFC blog link - CLAUDE.md: fix the project description, the Scan bottom-nav entry, and the NFC scan-state note (Scan tab and QR were removed in the same change as NFC)
1 parent 049eaa0 commit a362d9e

2 files changed

Lines changed: 5 additions & 51 deletions

File tree

CLAUDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
NativeAppTemplate-Free-Android is a native Android app (100% Kotlin, 100% Jetpack Compose) for managing walk-in customer waitlists using NFC tags and QR codes. It connects to a Rails backend API at `api.nativeapptemplate.com`. Inspired by [nowinandroid](https://github.com/android/nowinandroid).
7+
NativeAppTemplate-Free-Android is a native Android app (100% Kotlin, 100% Jetpack Compose) for managing walk-in customer waitlists. It connects to a Rails backend API at `api.nativeapptemplate.com`. Inspired by [nowinandroid](https://github.com/android/nowinandroid).
88

99
## Build & Run Commands
1010

@@ -39,14 +39,14 @@ MVVM layered architecture following [Android Modern App Architecture](https://de
3939
- **Network Layer** (`network/`): `AuthInterceptor` for token injection, `RequestHelper` for request construction.
4040
- **DI** (`di/modules/`): Hilt modules — `NetModule` (Retrofit/OkHttp), `DataModule` (repository bindings), `DataStoreModule`, `DispatchersModule`, `CoroutineScopesModule`.
4141
- **DataStore** (`datastore/`): Proto DataStore for user preferences. Proto definitions live in `app/src/main/proto/`.
42-
- **Navigation**: `NativeAppTemplateNavHost.kt` is the top-level nav graph. Three bottom-nav sections: Shops, Scan, Settings. Each section uses nested navigation graphs via `*BaseRoute`.
42+
- **Navigation**: `NativeAppTemplateNavHost.kt` is the top-level nav graph. Two bottom-nav sections: Shops, Settings. Each section uses nested navigation graphs via `*BaseRoute`.
4343

4444
## Key Patterns
4545

4646
- **API response handling**: Uses [Sandwich](https://github.com/skydoves/sandwich) library (`ApiResponse` type) for Retrofit call adaptation.
4747
- **Dependency injection**: Hilt with `@InstallIn(SingletonComponent::class)`. Repositories are bound via `@Binds` in `DataModule`.
4848
- **Navigation routes**: Defined as extension functions on `NavGraphBuilder` (e.g., `shopListView()`, `navigateToShopDetail()`). Routes use type-safe navigation.
49-
- **Proto DataStore**: User preferences and NFC scan state are persisted via Protocol Buffers (lite).
49+
- **Proto DataStore**: User preferences are persisted via Protocol Buffers (lite).
5050

5151
## Error Handling (CodedError System)
5252
All errors should use the `CodedError` interface. Error codes use the `NATIVEAPPTEMPLATE-XXXX` prefix (NativeAppTemplate Android).

README.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NativeAppTemplate-Free-Android
22

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.
44
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).
55

66
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
4545

4646
## NFC Tag Operations
4747

48-
<details>
49-
<summary><strong>How NFC tag writing and background reading works</strong></summary>
50-
51-
### Overview
52-
53-
![Screenshot showing Overview before](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android/blob/main/docs/images/overview_before.png "Screenshot showing Overview before")
54-
55-
![Screenshot showing Overview after](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android/blob/main/docs/images/overview_after.png "Screenshot showing Overview after")
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-
![Screenshot showing Write Application Info to Tag screen, Scan Tag screen, and Shop Detail screen](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android/blob/main/docs/images/screenshots_nfc.png "Screenshot showing Write Application Info to Tag screen, Scan Tag screen, and Shop Detail screen")
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-
![Gif showing Background Tag Reading](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android/blob/main/docs/images/nfc.gif "Showing Background Tag Reading")
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.
9449

9550
## Not Included in the Free Version
9651

@@ -137,7 +92,6 @@ Cleartext HTTP to private IPs is already permitted in debug via `app/src/debug/r
13792
## Blog
13893

13994
- [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)
14195

14296
## Contributing
14397

0 commit comments

Comments
 (0)