lynx README

The project's README from github.com/lynx-family/lynx. As one markdown file: README.md.

Lynx

Apache licesed Latest release version CI status X (formerly Twitter) URL Discord

Empower the web community and invite more to build across platforms

Content

About Lynx

Lynx is a family of open-source technologies empowering developers to use their existing web skills to create truly native UIs for both mobile and web from a single codebase, featuring performance at scale and velocity.

This repository contains the core engine of Lynx. For other repositories in the Lynx family, visit our org homepage.

Documentation

You shall find documentation for Lynx on lynxjs.org.

How to Use Lynx

Requirements

Lynx apps may target iOS 10 and Android 5.0 (API 21) or newer.

We recommend using macOS as the development operating system. Windows and Linux are not yet verified or guaranteed, so you may encounter problems. If you need assistance, please file an issue, and we will be more than happy to help you address it.

Getting Started guide

Lynx Explorer

Lynx Explorer is the official app for testing and exploring Lynx. It provides native runtime environments (Android/iOS/Harmony/Windows/macOS) and bundles ReactLynx-based screens.

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 Lynx Authors. It's people like you that make this project great.

Please refer to our contributing guide for details.

Discussions

Bugs and feature requests are filed in Github Issues

Large discussions and proposals are discussed in Github Discussions

You are always very welcome to join the Discord Channel and meet others who are enthusiastic about making Lynx great.

Credits

Lynx makes use of several third-party libraries and draws inspiration from various projects. We would like to express our sincere gratitude to these sources.

Third Party Libraries

Lynx incorporates the following third-party libraries, which have significantly contributed to its functionality. We appreciate the efforts of the developers and the open-source community behind these projects:

Referenced API Design and Implementations

The design of some APIs and some implementations in Lynx have been inspired by and referenced from the following outstanding projects. Their innovative designs and solutions have been invaluable in shaping Lynx:

We respect the intellectual property rights of all these projects and adhere to relevant open-source licenses and usage guidelines.

License

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

lynx (lynx-family/lynx)

Searching Database…

15.2K ·GitHub
What is this?Lynx is a family of open-source technologies that lets developers use their existing web skills (CSS, React) to build truly native UIs for mobile and web from a single codebase.
Is this a UI component library or a rendering engine?It's a cross-platform rendering framework/engine — this repo holds the core C++ engine that renders natively on Android, iOS, and Web, or through a custom renderer for pixel-perfect consistency across mobile and desktop.
How do I get started with Lynx?Start with the 'Trying out Lynx with hello world' guide, or follow 'Integrating Lynx with an Existing Application' to add Lynx to an app you already have; the Lynx Explorer app lets you test Lynx on real native runtimes.
What OS and device versions does Lynx support?Lynx apps can target iOS 10+ and Android 5.0 (API 21) or newer, and the team recommends developing on macOS.
Can I develop Lynx apps on Windows or Linux right now?Developing on Windows or Linux is not yet verified or guaranteed, so you may run into unexpected problems.
Which native runtimes can I actually test Lynx on?Lynx Explorer, the official testing app, bundles native runtime environments for Android, iOS, Harmony, Windows, and macOS.
What is ReactLynx?ReactLynx is the React-based UI layer used to build the demo screens bundled in Lynx Explorer, letting developers write native UIs with familiar React patterns.
How is Lynx different from React Native?Lynx's API design draws inspiration from React Native and the Flutter engine, but adds its own custom renderer for pixel-perfect consistency across mobile and desktop plus a multithreaded engine aimed at instant launch and smooth responsiveness.
Can I add Lynx to an app I already have instead of starting fresh?Yes — the 'Integrating Lynx with an Existing Application' guide covers embedding Lynx into an existing codebase rather than building from scratch.
Size
85.2 MB
Stars
15.2K
Age
1y
Commits · 90 Days