#Quick Start

#Create a new Lynx project

We use Rspeedy (a Rspack-based Lynx build tool) to build Lynx projects.

It is recommended to start a new project using create-rspeedy, which sets up everything automatically for you. To create a project, run:

npm create rspeedy@latest

After completing the prompts, create-rspeedy will create a folder with your project name.

#Prepare Lynx Explorer

Lynx Explorer is a sandbox for trying out Lynx quickly.

mkdir -p LynxExplorer-arm64.app/
tar -zxf LynxExplorer-arm64.app.tar.gz -C LynxExplorer-arm64.app/

mkdir -p LynxExplorer-x86_64.app/
tar -zxf LynxExplorer-x86_64.app.tar.gz -C LynxExplorer-x86_64.app/

#Start developing

1. Navigate to the created project:

cd <project-name>

2. Install the NPM dependencies with package manager:

npm install

3. To start the development server, run:

npm run dev

You will see a QR code showing up in the terminal, scan with your Lynx Explorer App or if you are using the simulator, just copy the bundle URL and past it on the "Enter Card URL" input in the Lynx Explorer App and hit "Go".

4. Make your first change

Open the src/App.tsx file in your code editor and make a change.

You should see the UI on your Lynx Explorer being updated automatically.

hello-worldsrc/App.tsx

Preview

#Debugging

Visit Lynx DevTool to download and open the Lynx DevTool desktop application. Use a USB cable to connect the debugging device, and start debugging.

Visit Debugging, learn how to debug your Lynx app.