Skip to content
Docs

Get Started

Taurify is a system that simplifies the process of Web-based desktop and mobile application development and distribution.

Installation

The Taurify CLI is all you need to turn your web application into a desktop and mobile app. The CLI is distributed on NPM, you can install it with your preferred package manager:

npm i -D taurify

Initializing

To start developing your application, you must initialize the Taurify configuration. Run taurify init and the CLI will guide you through the options that you must configure.

npm exec taurify init

Developing

The taurify CLI inspects your application project to determine default configuration values for your application dev and build scripts, dev server URL and build dist output path. It automatically supports Vite, Webpack, create-react-app, Parcel and esbuild. If it cannot resolve the configuration automatically, you must configure the productionSrc, devSrc, beforeDevCommand and beforeBuildCommand values. For more information, see the configuration documentation page.

Desktop

The taurify dev starts your development server and instantly opens a window that loads your frontend as a native application.

npm exec taurify dev

Mobile

The taurify dev --mobile can be used to start your app for mobile. It prints a QR code that must be read with the Taurify mobile app so you can develop your application on Android and iOS.

npm exec taurify dev -- --mobile

Download the Taurify app for iOS or Android to start developing your app for mobile:

App Store download linkApp Store download link

Distributing

The taurify build command triggers a new release of your application. Our servers take care of the distribution for all platforms, but you must prepare your application and configure the distribution first. See the distribution documentation.

To handle auto-updates you must configure your application to check and install them. See the updater guide for more information.

npm exec taurify build