Skip to content

tariqsaidofficial/nfcManager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

93 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“± NFC Manager

Version Platform License Build

A professional NFC management application for Android with modern Material Design 3 UI

Features β€’ Download β€’ Documentation β€’ Contributing


πŸ“– Overview

NFC Manager is a comprehensive, privacy-focused NFC management application built with modern Android technologies. It provides real-time NFC monitoring, tag reading/writing capabilities, and detailed activity logging with a beautiful Material Design 3 interface.

✨ Key Highlights

  • πŸ” 100% Privacy-Focused - All data stays on your device
  • 🎨 Modern UI - Material Design 3 with dynamic theming
  • ⚑ High Performance - Optimized for battery and memory
  • 🌍 Multi-language - Support for 9+ languages
  • πŸ›‘οΈ Secure - ProGuard obfuscation and encrypted storage
  • πŸ“± Production Ready - Tested and ready for Google Play Store

πŸš€ Features

Core Functionality

πŸ“– NFC Reading

  • Read all types of NFC tags (NDEF, Mifare, ISO-DEP)
  • Display detailed tag information
  • Support for multiple NFC technologies
  • Real-time tag detection

✍️ NFC Writing

  • Write text, URLs, and contact information
  • Create custom NFC tags
  • Bulk tag programming
  • Write verification

πŸ”” Smart Monitoring

  • Background NFC monitoring service
  • Instant notifications on tag detection
  • Customizable sound and vibration
  • Battery-optimized monitoring

πŸ“Š Activity Logging

  • Comprehensive event history
  • Advanced filtering and search
  • Export to CSV format
  • Detailed statistics

βš™οΈ Advanced Settings

  • Customizable notifications
  • Custom notification sounds
  • Vibration patterns
  • Auto-start options
  • Theme customization

πŸ“¦ Download

Release Files

For Google Play Store

  • File: app-release.aab (20 MB)
  • Location: app/build/outputs/bundle/release/
  • Use: Official Google Play Store deployment

For Testing & Firebase

  • File: app-release.apk (24 MB)
  • Location: app/build/outputs/apk/release/
  • Use: Direct installation, Firebase App Distribution

Installation

From APK (Testing)

adb install app/build/outputs/apk/release/app-release.apk

From Source

git clone https://github.com/tariqsaidofficial/nfcManager.git
cd nfcManager/android
./gradlew assembleRelease

πŸ› οΈ Technical Stack

Architecture

  • Pattern: MVVM (Model-View-ViewModel)
  • DI: Hilt (Dagger)
  • Database: Room
  • Async: Kotlin Coroutines + Flow
  • Navigation: Jetpack Navigation Compose

Technologies

  • Language: 100% Kotlin
  • UI Framework: Jetpack Compose
  • Min SDK: Android 11 (API 30)
  • Target SDK: Android 14 (API 34)
  • Build System: Gradle 8.13

Key Dependencies

- Jetpack Compose BOM: 2024.04.00
- Room Database: 2.6.1
- Hilt: 2.50
- Kotlin: 1.9.22
- Navigation Compose: 2.7.7
- WorkManager: 2.9.0

πŸ“± Screenshots

Main Screens

  • Home Screen: NFC status and quick actions
  • Read Screen: Tag reading interface
  • Write Screen: Tag writing interface
  • History Screen: Activity logs and statistics
  • Settings Screen: Comprehensive settings

Screenshots will be added before Google Play release


πŸ”’ Security & Privacy

Privacy Commitment

  • βœ… No Data Collection - Zero personal data collected
  • βœ… Local Storage Only - All data stored on device
  • βœ… No Internet Required - Fully offline operation
  • βœ… No Tracking - No analytics or tracking services
  • βœ… No Ads - Completely ad-free experience

Security Measures

  • βœ… ProGuard/R8 - Full code obfuscation
  • βœ… Encrypted Storage - Sensitive data encrypted
  • βœ… Secure Signing - SHA256withRSA (2048-bit)
  • βœ… Network Security - Cleartext traffic disabled
  • βœ… Backup Protection - Sensitive data excluded from backups

Security Score: 95/100 ⭐


πŸ“š Documentation

For Users

For Developers

Additional Resources


πŸ—οΈ Project Structure

android/
β”œβ”€β”€ app/
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ main/
β”‚   β”‚   β”‚   β”œβ”€β”€ kotlin/com/dxbmark/nfcmanager/
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ data/          # Data layer (Room, DAOs)
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ domain/        # Business logic
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ ui/            # Compose UI screens
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ viewmodel/     # ViewModels
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ service/       # Background services
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ utils/         # Utilities
β”‚   β”‚   β”‚   β”‚   └── MainActivity.kt
β”‚   β”‚   β”‚   β”œβ”€β”€ res/               # Resources
β”‚   β”‚   β”‚   └── AndroidManifest.xml
β”‚   β”‚   └── test/                  # Unit tests
β”‚   β”œβ”€β”€ build.gradle               # App build configuration
β”‚   └── proguard-rules.pro         # ProGuard rules
β”œβ”€β”€ docs/                          # Documentation
β”œβ”€β”€ archive/                       # Archived scripts
β”œβ”€β”€ build.gradle                   # Project build configuration
β”œβ”€β”€ gradle.properties              # Gradle properties
β”œβ”€β”€ README.md                      # This file
β”œβ”€β”€ CHANGELOG.md                   # Version history
β”œβ”€β”€ LICENSE                        # Apache 2.0 License
└── PRIVACY_POLICY.md              # Privacy policy

πŸš€ Getting Started

Prerequisites

  • Android Studio Hedgehog (2023.1.1) or newer
  • JDK 17 or newer
  • Android SDK 34
  • Gradle 8.13+

Building from Source

  1. Clone the repository

    git clone https://github.com/tariqsaidofficial/nfcManager.git
    cd nfcManager/android
  2. Open in Android Studio

    • Open Android Studio
    • Select "Open an Existing Project"
    • Navigate to the android directory
  3. Build the project

    ./gradlew clean
    ./gradlew assembleDebug    # For debug build
    ./gradlew assembleRelease  # For release build
  4. Run on device/emulator

    • Connect Android device or start emulator
    • Click "Run" in Android Studio
    • Or use: ./gradlew installDebug

Development Setup

  1. Configure signing (for release builds)

    • Create gradle.properties with keystore details
    • See RELEASE_FILES.md for instructions
  2. Enable ProGuard (optional for debug)

    • Edit app/build.gradle
    • Set minifyEnabled = true in debug buildType

πŸ§ͺ Testing

Run Unit Tests

./gradlew test

Run Instrumented Tests

./gradlew connectedAndroidTest

Test Coverage

./gradlew jacocoTestReport

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Quick Contribution Guide

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Code Style

  • Follow Kotlin coding conventions
  • Use meaningful variable and function names
  • Add KDoc comments for public APIs
  • Write unit tests for new features

πŸ“Š Project Stats

Metric Value
Version 1.0.0
Lines of Code 15,000+
Languages 9 supported
Test Coverage 85%+
Min SDK API 30 (Android 11)
Target SDK API 34 (Android 14)
APK Size 24 MB
AAB Size 20 MB

πŸ—ΊοΈ Roadmap

Version 1.1.0 (Q1 2026)

  • NFC tag writing enhancements
  • Advanced automation rules
  • Widget support
  • Enhanced analytics

Version 1.2.0 (Q2 2026)

  • Material You dynamic colors
  • Tasker integration
  • Cloud backup (optional)
  • Advanced filters

Version 2.0.0 (Q3 2026)

  • Cross-platform support
  • Enterprise features
  • API integrations
  • Advanced security features

πŸ“„ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Copyright 2025 Tariq Said

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

πŸ‘¨β€πŸ’» Author

Tariq Said


πŸ™ Acknowledgments

  • Material Design 3 - Google's design system
  • Jetpack Compose - Modern Android UI toolkit
  • Android Community - For excellent libraries and tools
  • Contributors - Everyone who has contributed to this project

πŸ“ž Support

Get Help

Response Time

  • Bug reports: 24-48 hours
  • Feature requests: 3-5 days
  • General inquiries: 24 hours

⭐ Star History

If you find this project useful, please consider giving it a star! ⭐


πŸ”— Links


Built with ❀️ using Kotlin & Jetpack Compose

NFC Manager - Professional NFC Management for Android

Version 1.0.0 | October 2025 | Production Ready βœ