❇️ Sparkling is the mobile cross-platform infrastructure used by TikTok

• About Sparkling
• Documentation
• Project Layout
• How to Contribute
• License

TikTok Sparkling is the mobile cross-platform development infrastructure for TikTok mobile app. Powered by Lynx & WebView.

• 📦 Out-of-the-box Lynx development framework. You can start a new Lynx app with Android, iOS project by Sparkling cli in minutes.
• 🔀 Scheme Driven Navigation between mutliple pages. You can navigate between multiple Lynx pages in your app by router.
• 🧩 TikTok-Proven Native Abilities. Lots of Lynx native abilities are supported, such as media, storage, etc.

The full documentation for Sparkling can be found in docs

• Get Started
• Integrate Sparkling into an existing app
• API Reference

• packages/sparkling-sdk Core Sparkling SDK
• packages/sparkling-method-sdk Sparkling Method SDK
• packages/methods Built-in Sparkling methods packages
• packages/sparkling-cli Sparkling CLI.
• packages/create-sparkling-app App scaffolding CLI
• packages/sparkling-method-cli Sparkling Method tooling
• packages/playground Playground app for local development
• template/sparkling-app-template App template used by npx create sparkling-app

We are devoted to ensuring a positive, inclusive, and safe environment for all contributors. Please find our Code of Conduct for detailed information.

We welcome you to join and become a member of Sparkling Authors. It's people like you that make this project great.

Please refer to our contributing guide for details.

Sparkling is Apache licensed, as found in the LICENSE file.