For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/lynxtron/introduction.md.
Lynxtron logo
Lynxtron
  • English

      • Getting Started with Lynxtron

      Welcome to the Lynxtron documentation! We will create a Lynxtron project and start developing.

      System Requirements

      Before you begin, ensure your development environment meets the following requirements:

      • Node.js 22: or later. You can check your version by running node -v.
      • TypeScript: The project might be written in TypeScript.
      • Chrome Browser: Used for debugging the Lynxtron main process.
      • LynxDevTool: used for debugging Lynx. You can download it from here.

      Create a Project

      It is recommended to quickly create a Lynxtron project by executing the following command:

      npm
      yarn
      pnpm
      bun
      deno
      npm create @lynx-js/lynxtron@latest

      Follow the prompts to create a Lynxtron project.

      Start Development

      1. Navigate into your Lynxtron project:
      cd <project-name>

      1. Install dependencies:

        npm
        yarn
        pnpm
        bun
        deno
        npm install

      2. Start the application:

        npm
        yarn
        pnpm
        bun
        deno
        npm run start

      After running, you will see the Hello Lynxtron application launch successfully, as shown below:

      Debugging Your Application

      1. Debugging the Main Process

      The main process runs in Node.js. You can debug it using Google Chrome's Developer Tools.

      1. Run npm run dev.
      2. Open Google Chrome and navigate to chrome://inspect.
      3. Click the Configure... button and make sure localhost:9222 is in the target discovery list.
      4. You should see your application's main.js under Remote Target. Click inspect to open the DevTools.

      Now you can set breakpoints, inspect variables, and see console.log output from main.js.

      2. Debugging Lynx

      Lynx is debugged using LynxDevTool.

      1. Make sure npm run dev is running.
      2. Visit Lynx DevTool to download and open the Lynx DevTool desktop application.
      3. It should automatically connect to the development server. You can now inspect the UI element tree, view console output, and debug your React components.

      Package Your Application

      You can use the following command to package your application:

      npm
      yarn
      pnpm
      bun
      deno
      npm run pack

      If you need to configure some custom parameters, you can modify the electron-builder.yml configuration file.

      For detailed configuration parameters of electron-builder.yml, please refer to electron-builder Configuration.

      Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.