❇️ The Cross-platform Infrastructure behind TikTok

Content

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

About Sparkling

⚠️ Sparkling is currently in public beta. We're excited to open-source the underlying architecture that has been battle-tested inside TikTok, and we're still evolving its public-facing surface area, including rolling out more APIs and improving the documentation. Feedback and contributions are welcome!

Large-scale apps like TikTok are never built with a single technology. Sparkling is the infrastructure we built to unlock Lynx at TikTok's scale, and we believe it can do the same for your app.

• 📦 Scaffold in minutes. Create a Lynx app targeting Android & iOS with a single CLI command.
• 🔀 Scheme-driven navigation. Route between Lynx pages and native screens with a unified URL scheme.
• 🧩 Production-proven native APIs. Built-in media, storage, and extensible through Sparkling Method.

Documentation

The full documentation for Sparkling can be found in docs

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

Project Layout

• packages/sparkling-sdk Core Sparkling SDK
• packages/sparkling-method Sparkling Method SDK
• packages/methods Built-in Sparkling methods packages
• packages/sparkling-app-cli CLI for build and run Sparkling apps.
• 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

How to Contribute

Code of Conduct

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

Contributing Guide

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.

License

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