spool-link-apps

KO | EN

gitlite — search

#shell #claude-code #gemini #monitoring #proxy #mysql #github #open-source #awesome #react

spool-link-apps

(★ 9)

Proof of Concept: SpoolLink is a companion app for Spoolman that links existing NFC tags to filament spools for use with Snapmaker U1

File Explorer

ZIP Download

- - build.yml
  - release.yml
- - build.gradle
- .gitignore
- build.gradle
- CLAUDE.md
- gradle.properties
- run.sh
- settings.gradle
- ANDROID.design.md
- ANDROID.md
- IOS.design.md
- IOS.md
- SPOOLMAN.md
- AppIcon.png
- generate_icon.py
- spoolman_base.svg
- - FilamentMetadata.swift
  - OpenSpoolFormat.swift
- - FilamentPresets.swift
  - OpenSpoolPayload.swift
  - ScanResult.swift
  - SpoolResponse.swift
  - TagPayload.swift
- - project.pbxproj
- - NFCManager.swift
  - SpoolmanAPI.swift
- - SpoolmanViewModel.swift
- - AssignSpoolSheet.swift
  - CreateSpoolSheet.swift
  - HistoryView.swift
  - MainView.swift
  - PresetEditorView.swift
  - ScanView.swift
  - SettingsView.swift
  - SpoolsView.swift
  - TagDetailView.swift
- .gitignore
- CLAUDE.md
- Info.plist
- Local.xcconfig.sample
- SpoolLink.entitlements
- SpoolLinkApp.swift
- capture-screenshot.sh
- - app.js
  - apple-touch-icon.png
  - favicon.ico
  - icon-192.png
  - icon-512.png
  - index.html
  - style.css
- .gitignore
- CLAUDE.md
- run.sh
.gitignore
.markdownlint.json
CLAUDE.md
LICENSE
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> This is just unstable proof of concept. Use this just as an example.

SpoolLink is a companion app for [Spoolman](https://github.com/Donkie/Spoolman) that links existing NFC
tags to filament spools for use with Snapmaker U1. It does not create custom NFC tags; it records and
manages tag UIDs in Spoolman so a tag is assigned to only one spool at a time. For writing tags, use
other applications from the relevant app marketplaces.

## How it works

1. Scan any NFC tag — blank tags and OpenSpool-format tags are both supported.
2. Assign the tag to an existing Spoolman spool, or create a new one. If the tag carries
   OpenSpool data, the filament fields are pre-filled automatically.
3. The card's UID is appended to the spool's `card_uids` custom field in Spoolman, and
   removed from any other spool it was previously linked to.

A tag can be reassigned or unlinked at any time by scanning it again. Spools work best
with two tags — one on each side — so the spool is detected regardless of orientation.

## Apps

| Platform | Location | Language | Guide |
|----------|----------|----------|-------|
| Android | `android-app/` | Kotlin / Jetpack Compose | [User Guide](docs/ANDROID.md) |
| iOS | `ios-app/` | Swift / SwiftUI | [User Guide](docs/IOS.md) |
| Web | `web-app/` | Plain HTML + JS | |

All three apps connect to the same Spoolman server over HTTP. Configure the server URL in Settings.
Only the Android and iOS apps are properly tested; the web app is currently not fully tested.

## Compatibility

| Feature | Android | iOS | Web |
|---------|---------|-----|-----|
| NTAG NFC tags | Yes | Yes | Yes |
| Mifare NFC tags | Yes | No | No |
| Scan tag | Yes | Yes | Yes |
| Read OpenSpool format | Yes | Yes | Yes |
| Create and assign spool | Yes | Yes | Yes |
| Requires HTTPS + CORS | No | No | Yes |
| Requires paid developer certificate | No | Yes (NFC entitlement) | No |

## Running

**Android** — requires a connected device with USB debugging enabled and Android SDK installed:

```bash
./android-app/run.sh
```

**iOS** — open `ios-app/NFCSpoolReader.xcodeproj` in Xcode and run on a physical device.
Requires a paid Apple Developer subscription — NFC entitlements are not available with a free
account.

**Web** — open `web-app/index.html` directly, or serve it with any static file server.
Requires Spoolman to be accessible over HTTPS and have CORS configured to allow the page's origin.

## Documentation

- [`docs/DESIGN.md`](docs/DESIGN.md) — UI/UX design guidelines: colors, button styles, component
  patterns, and screen layouts for both iOS and Android.
- [`docs/SPOOLMAN.md`](docs/SPOOLMAN.md) — Spoolman API protocol reference: all endpoints, field
  formats, NFC tag schema, and sync logic.
- [`docs/ANDROID.md`](docs/ANDROID.md) — Android user guide.
- [`docs/IOS.md`](docs/IOS.md) — iOS user guide.

## Project structure

```
android-app/   Android app (Kotlin / Jetpack Compose)
ios-app/       iOS app (Swift / SwiftUI)
web-app/       Web app (HTML + JS)
docs/          Design and API reference documentation
icons/         App icon source files
```

## License

This project is licensed under the [GNU General Public License v3.0](LICENSE).

spool-link-apps

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

spool-link-apps

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README