# ReactLynx

[**ReactLynx**](https://lynxjs.org/react/) is a framework that allows you to build cross-platform [**Lynx**](https://lynxjs.org/) apps with [**React**](https://react.dev/) paradigm. - **Aligned with React 17+**\ Built on battle-tested open-source implementations, it fully supports functional components, Hooks, and Context — the same set of modern React APIs. - **Made for Lynx**\ Dual-threaded React tailor-made for Lynx, carrying over Lynx's instant launch and silky UI responsiveness. - **Compatible with React Ecosystem**\ With [Jotai](https://jotai.org/) and [Zustand](https://zustand-demo.pmnd.rs/) for state management, [TanStack Query](https://tanstack.com/query/latest) for data fetching, Fast Refresh and DevTools for React components, everything you need is here. ## Content - [Content](#content) - [Getting Started](#getting-started) - [Documentation](#documentation) - [Community and Support](#community-and-support) - [Contributing](#contributing) - [License](#license) - [Credits](#credits) ## Getting Started For the quick start guide, please visit [Getting Started](https://lynxjs.org/guide/start/quick-start.html). ## Documentation You can find the documentation of ReactLynx on [ReactLynx website](https://lynxjs.org/react/). You can also find the following specific sections here: - [Getting Started](https://lynxjs.org/guide/start/quick-start.html) - [Introduction & Guides](https://lynxjs.org/react/introduction.html) - [API Reference](https://lynxjs.org/api/react.html) For the documentation of Lynx, please visit [Lynx](https://lynxjs.org/). ## Community and Support - [GitHub Issues](https://github.com/lynx-family/lynx-stack/issues) - Report bugs or request features ## Contributing We welcome contributions! Please see our [Code of Conduct](https://github.com/lynx-family/lynx-stack/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guide](https://github.com/lynx-family/lynx-stack/blob/main/CONTRIBUTING.md) for more details. ## License ReactLynx is [Apache License 2.0](https://github.com/lynx-family/lynx-stack/blob/main/LICENSE) licensed. ## Credits Thanks to: - [Preact](https://preactjs.com/) for creating a lightweight and efficient implementation of React's APIs that served as the foundation for ReactLynx runtime. - [React](https://react.dev/) for creating a gaming-changing UI library and programming model that has inspired a generation of declarative UI technologies. - [Reanimated](https://docs.swmansion.com/react-native-reanimated/), [React Server Component](https://react.dev/reference/rsc/server-components) and [Web Worklet](https://developer.mozilla.org/en-US/docs/Web/API/Worklet) for inspiring ReactLynx's dual-threaded programming models such as [Main Thread Scripting](https://lynxjs.org/react/main-thread-script.html). - [SWC](https://github.com/swc-project/swc) project created by [@kdy1](https://github.com/kdy1), which turbocharges ReactLynx's code transformation with Rust-powered efficiency, achieving sub-second build times and frictionless developer experience.