Welcome to the Bini.js documentation.
Bini.js is a full-stack React framework for building web, desktop, and mobile apps from a single codebase.
Web routes are pre-rendered to static HTML at build time, delivering the same SEO and first-paint guarantees you expect from a modern web framework. Desktop and mobile targets compile to native binaries through Tauri, using the operating system's built-in WebView rather than bundling a separate browser engine.
Routing, API routes, metadata, environment handling, and a production server work out of the box. Styling is your choice. The same routes and components ship to every target, with each platform compiled and packaged for distribution.
Bini.js does not stop at the browser. Every project that adds a desktop or mobile target produces a real, distributable native application - compiled, signed, and packaged for its platform - from the same routes and components you already wrote for the web. The UI renders through the operating system's built-in WebView, and native capabilities are served by a Rust backend rather than a bundled browser runtime.
Windows, macOS, and Linux builds share one project and one native configuration. Windows apps run in WebView2 and ship as NSIS or MSI installers with Authenticode signing. macOS apps run in WKWebView, signed with a Developer ID and notarized. Linux apps run in WebKitGTK and ship as AppImage, .deb, and .rpm bundles.
Android and iOS builds are generated from the same project. Android produces a native APK or AAB with keystore signing and Play Store support, running in the system WebView. iOS runs in WKWebView and distributes through the App Store and TestFlight. Both use Tauri's official backends and compile to native binaries with a Rust core.
Clipboard, notifications, geolocation, filesystem, and other native APIs are detected from your code and wired automatically during development. You do not hand-edit Rust manifests or maintain a parallel native codebase.
Each native target is compiled and packaged with its own build step, so desktop and mobile distributions are produced by their platform toolchains. A single command can also generate a GitHub Actions workflow that builds every target on its own runner and uploads signed installers as build artifacts. Code signing is configured once, locally or through CI secrets, and reused on every build.
The production build compiles the client, builds the server bundle, compiles API routes, and pre-renders every route to static HTML in a single pass. Static routes are discovered from the filesystem; dynamic routes are expanded through a staticParams export and by crawling internal links.
<route>/index.html at build time. The client hydrates the markup on load with no blank-screen flicker.staticParams to list the URLs to pre-render, or are discovered automatically when a rendered page links to them.export const prerender = false. A shell page is written instead and the route renders entirely on the client.Routes with data exports (loader, action, and related APIs) are client-only and receive a shell page automatically. See the Static Export documentation for the full model.
The documentation is organized into ten sections:
Bini.js uses a file-system router built on folder and file conventions:
[id], catch-alls use [...slug], and optional catch-alls use [[...slug]].page.tsx, layout.tsx, loading.tsx, error.tsx, and not-found.tsx. .mdx and .md pages are supported out of the box.(group), parallel routes @slot, and intercepting routes (.), (..), and (...).React.lazy() boilerplate and no manual export step.src/app/api/. A file can export a plain function, per-method handlers, or a Hono app, and runs identically in development, production, and on the edge.Start with the Routing documentation for the full guide.
The documentation assumes familiarity with web development. Before getting started, you should be comfortable with:
If you are new to React or need a refresher, start with the React documentation.
Welcome to the Bini.js documentation.
Bini.js is a full-stack React framework for building web, desktop, and mobile apps from a single codebase.
Web routes are pre-rendered to static HTML at build time, delivering the same SEO and first-paint guarantees you expect from a modern web framework. Desktop and mobile targets compile to native binaries through Tauri, using the operating system's built-in WebView rather than bundling a separate browser engine.
Routing, API routes, metadata, environment handling, and a production server work out of the box. Styling is your choice. The same routes and components ship to every target, with each platform compiled and packaged for distribution.
Bini.js does not stop at the browser. Every project that adds a desktop or mobile target produces a real, distributable native application - compiled, signed, and packaged for its platform - from the same routes and components you already wrote for the web. The UI renders through the operating system's built-in WebView, and native capabilities are served by a Rust backend rather than a bundled browser runtime.
Windows, macOS, and Linux builds share one project and one native configuration. Windows apps run in WebView2 and ship as NSIS or MSI installers with Authenticode signing. macOS apps run in WKWebView, signed with a Developer ID and notarized. Linux apps run in WebKitGTK and ship as AppImage, .deb, and .rpm bundles.
Android and iOS builds are generated from the same project. Android produces a native APK or AAB with keystore signing and Play Store support, running in the system WebView. iOS runs in WKWebView and distributes through the App Store and TestFlight. Both use Tauri's official backends and compile to native binaries with a Rust core.
Clipboard, notifications, geolocation, filesystem, and other native APIs are detected from your code and wired automatically during development. You do not hand-edit Rust manifests or maintain a parallel native codebase.
Each native target is compiled and packaged with its own build step, so desktop and mobile distributions are produced by their platform toolchains. A single command can also generate a GitHub Actions workflow that builds every target on its own runner and uploads signed installers as build artifacts. Code signing is configured once, locally or through CI secrets, and reused on every build.
The production build compiles the client, builds the server bundle, compiles API routes, and pre-renders every route to static HTML in a single pass. Static routes are discovered from the filesystem; dynamic routes are expanded through a staticParams export and by crawling internal links.
<route>/index.html at build time. The client hydrates the markup on load with no blank-screen flicker.staticParams to list the URLs to pre-render, or are discovered automatically when a rendered page links to them.export const prerender = false. A shell page is written instead and the route renders entirely on the client.Routes with data exports (loader, action, and related APIs) are client-only and receive a shell page automatically. See the Static Export documentation for the full model.
The documentation is organized into ten sections:
Bini.js uses a file-system router built on folder and file conventions:
[id], catch-alls use [...slug], and optional catch-alls use [[...slug]].page.tsx, layout.tsx, loading.tsx, error.tsx, and not-found.tsx. .mdx and .md pages are supported out of the box.(group), parallel routes @slot, and intercepting routes (.), (..), and (...).React.lazy() boilerplate and no manual export step.src/app/api/. A file can export a plain function, per-method handlers, or a Hono app, and runs identically in development, production, and on the edge.Start with the Routing documentation for the full guide.
The documentation assumes familiarity with web development. Before getting started, you should be comfortable with:
If you are new to React or need a refresher, start with the React documentation.