❇️ The Cross-platform Infrastructure behind TikTok
⚠️ 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.
The full documentation for Sparkling can be found in docs
packages/sparkling-sdkCore Sparkling SDKpackages/sparkling-methodSparkling Method SDKpackages/methodsBuilt-in Sparkling methods packagespackages/sparkling-app-cliCLI for build and run Sparkling apps.packages/create-sparkling-appApp scaffolding CLIpackages/sparkling-method-cliSparkling Method toolingpackages/playgroundPlayground app for local developmenttemplate/sparkling-app-templateApp template used bynpx 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.
| Role | Github |
|---|---|
| Creator & Lead Maintainer | @Kunyang Lee |
| Lead Maintainer | @HuxPro |
| Core Maintainer | @Chen-Jr |
| Core Contributor | @Yujie Zhang |
For bug reports, feature requests, and maintenance discussions, please open an issue in this repository.
Sparkling is Apache licensed, as found in the LICENSE file.