Visit https://pilot.waveplay.dev/docs to view the full documentation.

Create a new Pilot.js app via our interactive CLI:

npx create-pilot-app

This will guide you through a short customization process and create a fully working template.

Install the package:

npm install @waveplay/pilot

We assume you already have a working project with Expo and Next.js. If not, follow their respective guides:

• Expo - Get started
• Next.js - Getting Started
• Next.js - examples/with-expo

You can either let Pilot.js manage your app's entry or you can use the <PilotArea> component directly. The latter is useful if you need additional customization.

Edit your app.json to include the following:

{
  "expo": {
    "entryPoint": "node_modules/@waveplay/pilot/AppEntry.js"
  }
}

Update your App.js entry component to render PilotArea.

import { loadEnv } from '@waveplay/pilot/env'
import { PilotArea } from '@waveplay/pilot/ui'

// Loads public environment variables
loadEnv()

const App = () => {
  // ... your code

  return (
    <PilotArea/>
  )
}
export default App

You're now ready to use Pilot.js! Use it like you would use Next.js.

Pilot.js relies on the built-in CLI to detect pages and routes.

The build command will prepare your project. You must run this before you can use the start command or routing may not work.

pilot build

The dev command will start a development server on native + web.

pilot dev

This will:

1. Start a Next.js development server
2. Build Pilot.js & link to your local Next.js server
3. Start an Expo development server

You can use Pilot.js the same way as Next.js, except it now also works on React Native and Expo projects!

// const router = useRouter();
const pilot = usePilot();

// router.push('/dashboard');
pilot.fly('/dashboard'); // or pilot.push('/dashboard');

Note: If a feature is not in the table above, that likely means there are no plans to support it or we may have missed it. However, you can still use unsupported features in the web environment.

Native apps work much differently than a server which means some features may not be possible to support. Please open an issue if you'd like to see a feature added.

This project was originally developed as an internal router for WavePlay.

The MIT License.