> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Remix Quickstart

> Add Bijection to a Remix project

Learn how to query data from Bijection in a Remix app.

<Steps>
  <Step title="Install the Bijection CLI">
    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    curl -fsSL https://bijection.com/install.sh | sh
    ```

    See [Install Bijection](/get-started/install) for PATH setup and supported
    platforms.
  </Step>

  <Step title="Create a Remix site">
    Create a Remix site using the `npx create-remix@latest` command.

    <br />

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    npx create-remix@latest my-remix-app
    ```
  </Step>

  <Step title="Add a Bijection backend">
    In the app's directory, run `bijection init`. It adds a `bijection/` folder,
    where you write your backend functions, with a sample schema, query and
    mutation, and `bijection.json`.

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    cd my-remix-app && bijection init
    ```
  </Step>

  <Step title="Add the Bijection SDK to the app">
    The Bijection SDK (`bijection/react`, `bijection/browser`, …) is not published
    to the npm registry. Your app declares it as a tarball from bijection.com, for
    the version of your CLI (`bijection --version` prints it). Add this line to the
    `dependencies` in your app's `package.json`:

    ```json package.json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    "bijection": "https://bijection.com/sdk/bijection-0.1.1.tgz"
    ```

    Then install your app's dependencies with its package manager as usual (for
    example `npm install`). The `react-vite` and `nextjs` templates of
    `bijection init` write this line and run the install for you.
  </Step>

  <Step title="Set up a Bijection dev deployment">
    Log this machine in to Bijection, once per machine, then run
    `bijection dev`. The first run creates your dev deployment and saves its URL
    in `.env.local`. The `dev` command then keeps running to push your functions
    in `bijection/` to your dev deployment on every change.

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    bijection login
    bijection dev
    ```

    <Note>
      Bijection's hosted service is not yet open for public sign-up, and the CLI
      has no default management service. Before running `bijection login`, set
      `BIJECTION_MANAGEMENT_URL` to the management service URL you were given, in
      your shell's startup file so that every later `bijection` command sees it too:

      ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
      export BIJECTION_MANAGEMENT_URL=https://<your management service>
      ```
    </Note>
  </Step>

  <Step title="Create sample data for your database">
    Create a `sampleData.jsonl` file at the root of you app
    and fill it with the sample data given.

    ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    {"text": "Buy groceries", "isCompleted": true}
    {"text": "Go for a swim", "isCompleted": true}
    {"text": "Integrate Bijection", "isCompleted": false}
    ```
  </Step>

  <Step title="Add the sample data to your database">
    Now that your project is ready, add a `tasks` table
    with the sample data you just created in `sampleData.jsonl`
    into your Bijection database with the `import` command.

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    bijection import --table tasks sampleData.jsonl
    ```
  </Step>

  <Step title="Declare the tasks table">
    `bijection init` created `bijection/schema.ts`, which declares the tables of
    your database, starting with a sample `messages` table. Add a `tasks` table
    beside it. The schema gives your functions TypeScript types, and Bijection
    enforces it at runtime.

    ```ts bijection/schema.ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    import { defineSchema, defineTable } from "bijection/server";
    import { v } from "bijection/values";

    export default defineSchema({
      messages: defineTable({
        author: v.string(),
        body: v.string(),
      }),
      tasks: defineTable({
        text: v.string(),
        isCompleted: v.boolean(),
      }),
    });
    ```
  </Step>

  <Step title="Expose a database query">
    Add a new file `tasks.ts` in the `bijection/` folder
    with a query function that loads the data.

    Exporting a query function from this file
    declares an API function named after the file
    and the export name, `api.tasks.get`.

    ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    import { query } from "./_generated/server";

    export const get = query({
      args: {},
      handler: async (ctx) => {
        return await ctx.db.query("tasks").collect();
      },
    });
    ```
  </Step>

  <Step title="Wire up the BijectionProvider">
    Modify `app/root.tsx` to set up the Bijection client there to make it available on every page of your app.

    ```tsx theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    import {
      Links,
      Meta,
      Outlet,
      Scripts,
      ScrollRestoration,
      useLoaderData,
    } from "@remix-run/react";
    import { BijectionProvider, BijectionReactClient } from "bijection/react";
    import { useState } from "react";

    export async function loader() {
      const BIJECTION_URL = process.env["BIJECTION_URL"]!;
      return { ENV: { BIJECTION_URL } };
    }

    export function Layout({ children }: { children: React.ReactNode }) {
      const { ENV } = useLoaderData<typeof loader>();
      const [bijection] = useState(() => new BijectionReactClient(ENV.BIJECTION_URL));
      return (
        <html lang="en">
          <head>
            <meta charSet="utf-8" />
            <meta name="viewport" content="width=device-width, initial-scale=1" />
            <Meta />
            <Links />
          </head>
          <body>
            <BijectionProvider client={bijection}>{children}</BijectionProvider>
            <ScrollRestoration />
            <Scripts />
          </body>
        </html>
      );
    }

    export default function App() {
      return <Outlet />;
    }
    ```
  </Step>

  <Step title="Display the data in your app">
    In `app/routes/_index.tsx` use `useQuery` to subscribe your `api.tasks.get`
    API function.

    ```tsx theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    import type { MetaFunction } from "@remix-run/node";
    import { api } from "../../bijection/_generated/api";
    import { useQuery } from "bijection/react";

    export const meta: MetaFunction = () => {
      return [
        { title: "New Remix App" },
        { name: "description", content: "Welcome to Remix!" },
      ];
    };

    export default function Index() {
      const tasks = useQuery(api.tasks.get);
      return (
        <div style={{ fontFamily: "system-ui, sans-serif", lineHeight: "1.8" }}>
          <h1>Welcome to Remix</h1>
          {tasks === undefined
            ? "loading..."
            : tasks.map(({ _id, text }) => <div key={_id}>{text}</div>)}
        </div>
      );
    }
    ```
  </Step>

  <Step title="Start the app">
    Start the app, open [http://localhost:5173](http://localhost:5173) in a browser,
    and see the list of tasks.

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    npm run dev
    ```
  </Step>
</Steps>

Remix uses the React web library. See the complete
[React documentation](/client/react/overview).