Using Convex

Run the EAS CLI integration command

From your Expo project directory, run:

The command will prompt for a Convex deployment region, project name, and team name when needed. It only asks for a team name when it needs to create a new Convex team connection.

You can also pass values explicitly:

The integration command:

• Installs the convex package with npx expo install convex
• Creates a Convex team connection for your EAS account, or reuses an existing one
• Creates a Convex project and deployment for the current Expo app
• Writes CONVEX_DEPLOY_KEY and EXPO_PUBLIC_CONVEX_URL to .env.local
• Creates or updates the EXPO_PUBLIC_CONVEX_URL EAS project environment variable for the production, preview, and development environments
• Sends an invitation to your verified email so you can claim the Convex team and open the Convex dashboard

Start Convex locally

After the integration command finishes, start the Convex dev server:

This creates the local convex directory if your project does not have one yet, generates the typed API files, and syncs your Convex functions with your deployment while it runs.

Add a Convex provider

Create a Convex client with the deployment URL that the EAS integration wrote to .env.local, then wrap your app in ConvexProvider.

For an Expo Router project, update src/app/_layout.tsx:

import { ConvexProvider, ConvexReactClient } from 'convex/react';
import { Stack } from 'expo-router';

const convex = new ConvexReactClient(process.env.EXPO_PUBLIC_CONVEX_URL!, {
  unsavedChangesWarning: false,
});

export default function RootLayout() {
  return (
    <ConvexProvider client={convex}>
      <Stack />
    </ConvexProvider>
  );
}

Query Convex from your app

Add a query function in the convex directory:

import { query } from './_generated/server';

export const get = query({
  args: {},
  handler: async ctx => {
    return await ctx.db.query('tasks').collect();
  },
});

Then call it from your app with useQuery:

import { api } from '@/convex/_generated/api';
import { useQuery } from 'convex/react';
import { Text, View } from 'react-native';

export default function Index() {
  const tasks = useQuery(api.tasks.get);

  return (
    <View>
      {tasks?.map(task => (
        <Text key={task._id}>{task.text}</Text>
      ))}
    </View>
  );
}