Vue Quickstart

Learn how to query data from Bijection in a Vue app. This quickstart uses the JavaScript client directly: BijectionClient.onUpdate subscribes to a query and updates a Vue ref. See Vue for other options.

Install the Bijection CLI

curl -fsSL https://bijection.com/install.sh | sh

See Install Bijection for PATH setup and supported platforms.

Create a Vue site

Create a Vue site using the npm create vue@latest my-vue-app command.Bijection will work with any set of options but to follow this quickstart most closely choose:

Yes to “Add TypeScript?”
No to everything else

npm create vue@latest my-vue-app

Add a Bijection backend

In the site’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.

cd my-vue-app && bijection init

Add the Bijection SDK to the site

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:

package.json

"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.

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 as VITE_BIJECTION_URL. The dev command then keeps running to push your functions in bijection/ to your dev deployment on every change.

bijection login
bijection dev

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:

export BIJECTION_MANAGEMENT_URL=https://<your management service>

Create sample data for your database

In a new terminal window, create a sampleData.jsonl file with some sample data.

{"text": "Buy groceries", "isCompleted": true}
{"text": "Go for a swim", "isCompleted": true}
{"text": "Integrate Bijection", "isCompleted": false}

Add the sample data to your database

Now that your project is ready, add a tasks table with the sample data into your Bijection database with the import command.

bijection import --table tasks sampleData.jsonl

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.

bijection/schema.ts

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(),
  }),
});

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.

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

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

Create the Bijection client

In a new file src/bijection.ts, create one BijectionClient for your deployment, shared by every component.

src/bijection.ts

import { BijectionClient } from "bijection/browser";

export const bijection = new BijectionClient(import.meta.env.VITE_BIJECTION_URL);

Display the data in your app

In src/App.vue, subscribe to your api.tasks.get API function with onUpdate. The callback runs with the first result and again whenever the tasks change; unsubscribe when the component unmounts.

src/App.vue

<script setup lang="ts">
import type { FunctionReturnType } from "bijection/server";
import { onUnmounted, ref } from "vue";
import { api } from "../bijection/_generated/api";
import { bijection } from "./bijection";

const tasks = ref<FunctionReturnType<typeof api.tasks.get>>();
const unsubscribe = bijection.onUpdate(api.tasks.get, {}, (result) => {
  tasks.value = result;
});
onUnmounted(() => unsubscribe());
</script>

<template>
  <span v-if="tasks === undefined"> Loading... </span>
  <ul v-else>
    <li v-for="task in tasks" :key="task._id">
      {{ task.text }} {{ task.isCompleted ? "☑" : "☐" }}
    </li>
  </ul>
</template>

Start the app

Start the app, open http://localhost:5173 in a browser, and see the list of tasks.

npm run dev

See the JavaScript client for mutations, actions and the rest of BijectionClient.

Get Started

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference