Welcome to the comprehensive documentation for Linktree's LinkApp SDK! This repository contains all the information you need to develop, test, and publish custom Link Apps for the Linktree platform.

• Getting Started - Complete setup guide, prerequisites, authentication, and your first Link App

• File Structure - Understanding the Link App project structure and organization
• Manifest.json - Link App metadata and configuration
• LinkApp Visibility - Understanding visibility controls and access management
• Settings.json - User-configurable settings and form elements

• Components - Complete guide to SDK components and UI building blocks
• URL Matching Rules - Advanced URL handling and content extraction

• Submitting for Review - Review process, requirements, and best practices

1. Prerequisites: Ensure you have Node.js 14+, npm 7+, and a code editor
2. Get Access: Contact your Technical Support Person (TSP) with your NPM username and Linktree account
3. Create Project: Run npm init @linktr.ee/link-app your-app-name
4. Develop: Build your Link App using the SDK components and guidelines
5. Test: Add your Link App to your authorized Linktree profile for testing
6. Submit: Contact your TSP when ready for review

The SDK provides a comprehensive set of React components:

• Layout: Container, Header, GroupedList
• Media: Image, Video, Embed, Carousel
• Interactive: Links, LinkList, DateWidget
• Content: Text, Pill, MediaDetails, Icon

• manifest.json: App metadata, author info, and marketplace details
• settings.json: User-configurable form fields and validation
• package.json: Dependencies and build scripts

• Mobile-First: All components are optimized for mobile devices
• Accessibility: Built-in accessibility features and best practices
• Performance: Optimized loading and rendering
• TypeScript: Full TypeScript support for better development experience

• NPM access granted by TSP
• Linktree account authorized for testing
• Link App name and ID decided
• Development environment set up

• Use SDK components for consistency
• Follow mobile-first design principles
• Implement proper error handling
• Test across different devices and browsers
• Optimize for performance

• Complete functionality testing
• Verify accessibility compliance
• Optimize loading performance
• Update all configuration files
• Test with various user inputs

# Create new Link App
npm init @linktr.ee/link-app my-link-app

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Upload to Linktree platform
npm run upload

# Authenticate with Linktree
npm run login

• Linktree SDK Documentation - Official online documentation
• Linktree Developer Portal (contact TSP for access)
• SDK GitHub Repository (contact TSP for access)

• Technical Support Person (TSP): Your primary contact for development support
• Community Forums: Connect with other Link App developers
• Documentation Issues: Report documentation problems via your TSP

1. User Experience First: Design for your users, not just functionality
2. Mobile Optimization: Ensure excellent mobile experience
3. Performance Matters: Optimize loading times and interactions
4. Accessibility: Make your Link App usable by everyone
5. Error Handling: Gracefully handle all error scenarios
6. Testing: Test thoroughly before submission
7. Documentation: Document your code and configuration clearly

Link Apps developed using this SDK are subject to Linktree's terms of service and developer agreement. Please ensure your Link App complies with all platform guidelines and policies.

Ready to get started? Begin with the Getting Started guide to create your first Link App!