README.en.md

🍎 HIG Lab

Hands-on Apple Frameworks, one at a time

🇰🇷 한국어 | 🇺🇸 English

Learn the top 50 of Apple's 367 frameworks through practical, hands-on projects. Each technology includes:

1. 📝 Blog Post — HIG guideline walkthrough + real-world examples
2. 📚 DocC Tutorial — Step-by-step guide you can follow right in Xcode (10+ chapters)
3. 💻 Sample Project — Production-quality SwiftUI app (avg. 5,000+ lines)
4. 🛠️ AI Skills — Ready-to-use config files for Claude Code, Cursor, and Copilot

🌐 Live Site: m1zz.github.io/HIGLab

🌱 New to iOS? → Start with the Getting Started Guide (GETTING_STARTED.md)!

---

📊 Progress

Category	Done	Progress
📝 Blog	50/50	100% ✅
📚 DocC	50/50 (10+ chapters)	100% ✅
💻 Samples	43 (covering all 50)	100% ✅
🛠️ Skills	3 (Claude/Cursor/Copilot)	100% ✅

🎉 Project Complete! Full coverage of all 50 technologies

📈 Project Scale

• Total sample projects: 43
• Total Swift files: 468
• Total lines of code: 148,411
• Average sample size: 3,450 lines (senior-level quality)

---

💻 Sample Projects (43)

🚀 Phase 1: App Frameworks

Sample	Technology	Size	Description
WeatherWidget	WidgetKit, WeatherKit	5,577 lines	All widget sizes + interactive
TaskMaster	SwiftUI, SwiftData, Observation	1,647 lines	CRUD + sync
DeliveryTracker	ActivityKit	1,766 lines	Live Activity + Dynamic Island
SiriTodo	App Intents	5,689 lines	12 intents + widgets
AIChatbot	Foundation Models	6,285 lines	Tool use + streaming

💳 Phase 2: App Services

Sample	Technology	Size	Description
SubscriptionApp	StoreKit 2	2,043 lines	Subscriptions + IAP
PremiumApp	StoreKit 2	1,900 lines	IAP + restore
CartFlow	PassKit	5,391 lines	Full Apple Pay implementation
CloudNotes	CloudKit	1,952 lines	iCloud sync
SecureVault	AuthServices, LocalAuth, CryptoKit	5,935 lines	Sign in with Apple + biometrics + encryption
HealthTracker	HealthKit	3,929 lines	Steps/heart rate/sleep/workouts
PlaceExplorer	MapKit	1,793 lines	Maps + POI
LocationTracker	Core Location	3,429 lines	GPS + geofencing
MLClassifier	Core ML	5,502 lines	Vision + real-time classification
VisionScanner	Vision, Visual Intelligence	2,131 lines	OCR + object detection
NotifyMe	User Notifications	2,684 lines	Local/push notifications
TipShowcase	TipKit	6,694 lines	All scenarios
WatchParty	SharePlay	3,296 lines	GroupActivity + synced playback

🎮 Phase 3: Graphics & Media

Sample	Technology	Size	Description
ARFurniture	ARKit, RealityKit	2,064 lines	AR furniture placement
SpaceShooter	SpriteKit	2,804 lines	2D shooting game
FilterLab	Core Image	2,516 lines	30+ filters + Metal kernel
SketchPad	PencilKit	1,750 lines	Drawing app
PDFReader	PDFKit	3,057 lines	PDF viewer/editor
CameraApp	AVFoundation	6,046 lines	Full camera features
MusicPlayer	MusicKit, AVKit	1,591 lines	Apple Music integration
PhotoGallery	PhotosUI	6,326 lines	Gallery + editing
HapticDemo	Core Haptics	2,757 lines	Haptic pattern editor
SoundMatch	ShazamKit	5,484 lines	Music recognition + MusicKit
ImageMaker	Image Playground	2,775 lines	AI image generation

🔧 Phase 4: System & Network

Sample	Technology	Size	Description
BLEScanner	Core Bluetooth	2,237 lines	BLE device connection
NFCReader	Core NFC	3,599 lines	Tag read/write
PeerChat	MultipeerConnectivity	2,677 lines	P2P chat
NetMonitor	Network	2,447 lines	Network monitoring
VoIPPhone	CallKit	2,840 lines	VoIP calls
CalendarPlus	EventKit	3,306 lines	Calendar + reminders
ContactBook	Contacts	3,330 lines	Contact management
DirectShare	Wi-Fi Aware	2,718 lines	AP-free P2P transfer

🆕 Phase 5: iOS 26

Sample	Technology	Size	Description
WakeUp	AlarmKit	2,761 lines	System alarms
GreenCharge	EnergyKit	4,399 lines	Power grid forecast
PermissionHub	PermissionKit	3,497 lines	Unified permission management
SmartFeed	RelevanceKit	3,921 lines	Content recommendation
DevicePair	AccessorySetupKit	2,729 lines	Accessory pairing
SmartCrop	ExtensibleImage	3,137 lines	AI image editing

---

📚 DocC Tutorials (50)

All tutorials have 10+ chapters.

# Example: run a tutorial
cd tutorials/widgets
swift package generate-documentation --target HIGWidgets

---

🏆 Senior-Level Code Quality

Every sample project targets 9/10 quality by a 10-year Apple developer standard:

• ✅ Full API coverage — Uses each framework's key classes/protocols
• ✅ Error handling — Custom error types + LocalizedError
• ✅ Swift Concurrency — async/await + Actor patterns
• ✅ Accessibility — VoiceOver support
• ✅ Documentation — Full /// doc comments
• ✅ SwiftUI Previews — #Preview macros throughout

---

📁 Project Structure

HIGLab/
├── site/                    # 📝 Blog posts (50)
│   ├── index.html
│   └── {framework}/01-*.html
├── tutorials/              # 📚 DocC tutorials (50)
│   └── {framework}/        # Swift Package + DocC
├── samples/               # 💻 Sample projects (43)
│   └── {SampleName}/      # Complete SwiftUI apps
├── ai-reference/          # 🤖 AI Reference (50)
│   └── {framework}.md
├── skills/                # 🛠️ AI Skills (Claude/Cursor/Copilot)
│   ├── claude-code/
│   ├── cursor/
│   └── copilot/
└── SSOT.json              # Single Source of Truth

---

🤖 AI Reference (50)

Reference documents designed to help AI generate accurate iOS code.

👉 Usage Guide — Prompt tips, examples, troubleshooting 👉 Full Document List — All 50 AI Reference catalog

App Frameworks (8)

Document	Description
swiftui.md	SwiftUI basics
swiftui-observation.md	@Observable state management
swiftdata.md	SwiftData CRUD
widgets.md	WidgetKit implementation
activitykit.md	Live Activity, Dynamic Island
appintents.md	Siri & Shortcuts integration
foundation-models.md	On-device LLM
tipkit.md	Feature tips & onboarding

App Services (16)

Document	Description
storekit.md	In-app purchases & subscriptions
passkit.md	Apple Pay & Wallet
cloudkit.md	iCloud sync
authservices.md	Sign in with Apple
localauth.md	Face ID / Touch ID
cryptokit.md	Encryption & hashing
healthkit.md	Health data
mapkit.md	Maps & POI
corelocation.md	GPS & geofencing
coreml.md	On-device ML
vision.md	Image analysis & OCR
notifications.md	Push/local notifications
shareplay.md	FaceTime shared experiences
eventkit.md	Calendar & reminders
contacts.md	Contact management
musickit.md	Apple Music integration

Graphics & Media (13)

Document	Description
arkit.md	Augmented reality
realitykit.md	3D rendering
spritekit.md	2D game engine
coreimage.md	Image filters
pencilkit.md	Apple Pencil drawing
pdfkit.md	PDF viewer/editor
avfoundation.md	Camera & audio
avkit.md	Video playback
photosui.md	Photo library
corehaptics.md	Haptic feedback
shazamkit.md	Music recognition
image-playground.md	AI image generation
weatherkit.md	Weather data

System & Network (6)

Document	Description
core-bluetooth.md	BLE device connection
core-nfc.md	NFC tag read/write
multipeerconnectivity.md	P2P communication
network.md	Low-level networking
callkit.md	VoIP calls
wifi-aware.md	Wi-Fi direct connection

iOS 18+ Apple Intelligence (7)

Document	Description
visual-intelligence.md	Visual analysis
alarmkit.md	Alarm clock
energykit.md	Energy data
permissionkit.md	Unified permission management
relevancekit.md	Context-based recommendations
accessorysetupkit.md	Accessory pairing
extensibleimage.md	Image editing extensions

💡 Feed these docs to Claude, GPT, or Cursor for accurate iOS code generation!

---

🚀 Getting Started

Browse the Blog

open https://m1zz.github.io/HIGLab/

Run DocC Tutorials

cd tutorials/widgets
swift package --disable-sandbox preview-documentation --target HIGWidgets

Run Sample Projects

See the README.md inside each sample folder.

cd samples/WeatherWidget
cat README.md

---

🤖 AI Agent Support

We support llms.txt for efficient AI agent consumption.

Endpoint	Description
/llms.txt	Project summary + 50 AI Reference links
/llms-full.txt	All 50 AI References combined (markdown)
/ai-reference/*.md	Individual framework reference docs

💡 Provide the llms.txt URL to Claude, GPT, or Cursor for accurate iOS code generation.

---

🛠️ AI Skills — AI Coding Tool Integration

What are Skills?

Config files that help AI coding tools (Claude Code, Cursor, Copilot) generate more accurate iOS code.

Problem: AI often uses deprecated APIs or doesn't know iOS 17+ patterns (@Observable, SwiftData).
Solution: HIG Lab's AI Reference as Skills gives AI access to best practices for 50 Apple frameworks.

👉 Installation Guide

---

📦 Quick Install

Claude Code — /hig Command

# Global install (available in all projects)
mkdir -p ~/.claude/commands
curl -o ~/.claude/commands/hig.md https://raw.githubusercontent.com/M1zz/HIGLab/main/skills/claude-code/hig.md

Cursor

# Copy to project root
curl -o .cursorrules https://raw.githubusercontent.com/M1zz/HIGLab/main/skills/cursor/.cursorrules

GitHub Copilot

mkdir -p .github
curl -o .github/copilot-instructions.md https://raw.githubusercontent.com/M1zz/HIGLab/main/skills/copilot/copilot-instructions.md

---

💡 Usage Examples

Using /hig Command in Claude Code

You: /hig storekit
     Add in-app purchase functionality

AI:  (Automatically fetches StoreKit 2 AI Reference)
     I'll implement using Product.products(for:) with @Observable pattern...

Korean keywords also work:

/hig 인앱결제    → StoreKit 2
/hig 위젯       → WidgetKit
/hig list      → All 50 frameworks

Before & After

	Before (without Skills)	After (with Skills)
State	@StateObject, ObservableObject	✅ @Observable (iOS 17+)
Data	Core Data + @FetchRequest	✅ SwiftData + @Query
IAP	StoreKit 1 completion handlers	✅ StoreKit 2 async/await
Errors	print(error)	✅ LocalizedError protocol

---

🔧 Supported Tools

Tool	File	Description
Claude Code	skills/claude-code/hig.md	/hig slash command
Cursor	skills/cursor/.cursorrules	Auto context awareness
GitHub Copilot	skills/copilot/copilot-instructions.md	VS Code auto-apply
Other AI	llms.txt / llms-full.txt	URL: https://m1zz.github.io/HIGLab/llms.txt

💡 Clone the project and open it with your AI coding tool — the AI will automatically reference all 50 framework documents to generate accurate iOS code.

---

🤝 Contributing

PRs welcome!

📄 License

MIT License. Use freely.

---

Made with ❤️ by 개발자리 (Leeo)