# ShipSwift
**Repository Path**: gaojacctno/ShipSwift
## Basic Information
- **Project Name**: ShipSwift
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-02
- **Last Updated**: 2026-03-02
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# ShipSwift

**AI-native SwiftUI component library — production-ready code that LLMs can use to build real apps.**
[](https://opensource.org/licenses/MIT)
[](https://swift.org)
[](https://developer.apple.com/ios/)
[](https://github.com/signerlabs/shipswift-skills)
[Quick Start](#quick-start) · [Components](#components) · [Directory Structure](#directory-structure) · [Recipes](#recipes) · [Contributing](#contributing)
---
## Quick Start
### Option 1: Skills + Recipe Server (Recommended)
**Step 1** — Install ShipSwift Skills:
```bash
npx skills add signerlabs/shipswift-skills
```
**Step 2** — Connect the recipe server so your AI can fetch recipes:
```bash
# Claude Code
claude mcp add --transport http shipswift https://api.shipswift.app/mcp
# Gemini CLI
gemini mcp add --transport http shipswift https://api.shipswift.app/mcp
```
For Cursor, VS Code Copilot, Windsurf, and other tools, see the [Skills repo](https://github.com/signerlabs/shipswift-skills) for MCP setup.
**Step 3** — Ask your AI:
- "Add a shimmer loading animation"
- "Build an authentication flow with Cognito"
- "Show me all chart components"
### Option 2: File Copy
1. Clone this repository
2. Copy the files you need from `ShipSwift/SWPackage/` into your Xcode project
3. Each component in `SWAnimation/`, `SWChart/`, and `SWComponent/` is self-contained — just copy the file and `SWUtil/` if needed
### Run the Showcase App
```bash
git clone https://github.com/signerlabs/ShipSwift.git
cd ShipSwift
open ShipSwift.xcodeproj
```
Select a simulator or device, then press **Cmd+R** to build and run.
---
## Components
### SWAnimation — Animation Components
BeforeAfterSlider · TypewriterText · ShakingIcon · Shimmer · GlowSweep · LightSweep · ScanningOverlay · AnimatedMeshGradient · OrbitingLogos
### SWChart — Chart Components
LineChart · BarChart · AreaChart · DonutChart · RingChart · RadarChart · ScatterChart · ActivityHeatmap
### SWComponent — UI Components
**Display:** FloatingLabels · ScrollingFAQ · RotatingQuote · BulletPointText · GradientDivider · Label · OnboardingView · OrderView · RootTabView
**Feedback:** Alert · Loading · ThinkingIndicator
**Input:** TabButton · Stepper · AddSheet
### SWModule — Multi-File Frameworks
- **SWAuth** — User authentication (Amplify/Cognito, social login, email/password, phone sign-in with country code picker)
- **SWCamera** — Camera capture with viewfinder, zoom, photo picker, and face detection with Vision landmark tracking
- **SWPaywall** — Subscription paywall using StoreKit 2 — *iOS client included free. Full-stack recipe (backend + compliance + pitfalls) → [Pro](https://shipswift.app/#pricing)*
- **SWChat** — All-in-one chat view with message list, text input, and optional voice recognition (VolcEngine ASR)
- **SWSetting** — Settings page template with language switch, share, legal links, recommended apps
- **SWTikTokTracking** — TikTok Events API integration for attribution tracking — *iOS client included free. Full-stack recipe (backend + compliance + pitfalls) → [Pro](https://shipswift.app/#pricing)*
### SWUtil — Shared Utilities
DebugLog · String/Date/View extensions · LocationManager
---
## Directory Structure
```
ShipSwift/
├── SWPackage/
│ ├── SWAnimation/ # Animation components
│ ├── SWChart/ # Chart components
│ ├── SWComponent/ # UI components
│ │ ├── Display/ # Display components
│ │ ├── Feedback/ # Feedback components
│ │ └── Input/ # Input components
│ ├── SWModule/ # Multi-file frameworks
│ │ ├── SWAuth/ # Authentication
│ │ ├── SWCamera/ # Camera + face detection
│ │ ├── SWPaywall/ # Subscription paywall
│ │ ├── SWChat/ # Chat + voice input
│ │ ├── SWSetting/ # Settings page
│ │ └── SWTikTokTracking/ # TikTok attribution
│ └── SWUtil/ # Shared utilities
├── View/ # Showcase app views
└── Component/ # Shared app components
```
---
## Naming Convention
All types use the `SW` prefix (e.g., `SWAlertManager`, `SWStoreManager`).
View modifiers use `.sw` lowercase prefix (e.g., `.swAlert()`, `.swPageLoading()`, `.swPrimary`).
## Dependency Rules
```
SWUtil ← no dependencies on other SWPackage directories
SWAnimation ← may depend on SWUtil only
SWChart ← may depend on SWUtil only
SWComponent ← may depend on SWUtil only
SWModule ← may depend on SWUtil and SWComponent
```
---
## Recipes
ShipSwift provides **free and pro recipes** via Skills — each recipe includes complete SwiftUI source code, implementation steps, and best practices. Your AI assistant can retrieve any recipe on demand.
| Category | Examples |
|----------|----------|
| Animation | Shimmer, Typewriter, Orbiting Logos |
| Chart | Line, Bar, Donut, Radar, Heatmap |
| Component | Alert, Onboarding, Stepper, FAQ |
| Module | Auth, Camera, Chat, Setting, Infra CDK, Subscription\*, TikTok Tracking\*, Export & Share\* |
\* Pro recipes — includes full backend, compliance templates, and pitfall guides. *Coming soon: Push Notifications, Analytics Dashboard.*
Three tools are available: `listRecipes`, `getRecipe`, `searchRecipes`.
Learn more at [shipswift.app](https://shipswift.app) · Skills repo: [signerlabs/shipswift-skills](https://github.com/signerlabs/shipswift-skills)
---
## Free vs Pro
All iOS client code is open-source under the MIT license. Pro recipes add everything you need to go from prototype to production.
| | Free (Open Source) | Pro Recipe |
|---|---|---|
| iOS client code | Full source | Enhanced version |
| Backend implementation | — | Hono routes, DB schema, webhooks |
| Integration guides | — | End-to-end setup checklists |
| Compliance templates | — | Privacy manifest, App Store labels |
| Known pitfalls | — | 10+ battle-tested tips per recipe |
More Pro recipes coming soon: **Push Notifications**, **Analytics Dashboard**.
See [pricing](https://shipswift.app/#pricing) for details.
---
## Tech Stack
- SwiftUI + Swift
- StoreKit 2
- Amplify SDK (Cognito)
- AVFoundation + Vision
- SpriteKit
- VolcEngine ASR
---
## Contributing
Contributions are welcome! Please follow these steps:
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
### Code Style
- All comments and documentation in English
- All types use the `SW` prefix
- Each file in `SWAnimation/`, `SWChart/`, and `SWComponent/` must be self-contained
- Follow existing code patterns and naming conventions
---
## License
This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.
---
Made with ❤️ by [SignerLabs](https://github.com/signerlabs)