Skip to content

Mention create-lynxjs-app CLI in Quick Start doc #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Mention create-lynxjs-app CLI in Quick Start doc #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d576c6
Mention `create-lynxjs-app` CLI
szymonrybczak Oct 2, 2025
f2f93c6
fixup
szymonrybczak Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cspell/dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jsbridge
jscpuprofile
jssdk
lynxdevtool
lynxjs
lynxsdk
mousedbclick
napi
Expand Down
15 changes: 15 additions & 0 deletions docs/en/guide/start/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ Welcome to the Lynx documentation! We will create a Lynx project and start devel

## Installation

### Create a new Lynx app
Copy link
Collaborator

@Huxpro Huxpro Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the current default path is brownfield and we are now introducing a new greenfield path, I suggest we described that we have two paths clearly upfront at the start of Quick Start (somewhat similar to how React introduces "From the scratch" and "Framework"):

image

And then we can link to a sub-section within this page titled something like "Create a Lynx project with the Native App Template"


You can use the [`create-lynxjs-app`](https://github.com/lynx-community/cli) CLI tool to scaffold a new Lynx project with native projects already integrated. This approach is ideal when you want to build new app with Lynx from scratch.

<PackageManagerTabs
command={{
npm: 'npx create-lynxjs-app@latest',
yarn: 'yarn create lynxjs-app',
pnpm: 'pnpm create lynxjs-app@latest',
bun: 'bunx create-lynxjs-app@latest',
}}
/>

This will set up a project structure that includes native iOS and Android configurations alongside your Lynx code.

<Steps>

### Create a new Lynx project
Expand Down