Skip to main content

Use Juno with Vue

Explore how to create a Juno project developed with Vue.

Table of contents​

Quickstart​

This guide provides quickstart instructions for integrating Juno in two scenarios: starting a new project and adding Juno to an existing Vue app.

Additionally, it covers how to develop against a production environment or locally.

Path A: Start a new project with a template​

  1. Create a new project using the Juno quickstart CLI:
npm create juno@latest

Path B: Integrate Juno into an existing Next.js app​

  1. Add the Juno SDK:

Navigate to your existing app directory and install Juno SDK:

cd your-existing-app
npm i @junobuild/core

2. Configure Datastore​

Production Path​

To use production, set up a satellite and new collection:

  • Create a new satellite in the Juno's console.
  • After your project is ready, create a collection in your datastore, which we'll call demo, using the console.

Local Development Path​

To develop with the local emulator, add a collection named demo within the juno.dev.config.ts file.

import { defineDevConfig } from "@junobuild/config";

export default defineDevConfig(() => ({
  satellite: {
    collections: {
      db: [
        {
          collection: "demo",
          read: "managed" as const,
          write: "managed" as const,
          memory: "stable" as const,
          mutablePermissions: true
        }
      ]
    }
  }
}));
  • Once set, run the local emulator:
juno dev start
  • If the Juno admin CLI (required for deployment, configuration, or to run the emulator) is not installed yet, run:
npm i -g @junobuild/cli

3. Insert data from your app​

In App.vue, initialize the library with the satellite ID you have created for production, or use jx5yt-yyaaa-aaaal-abzbq-cai if you are developing locally with the emulator.

Add an insert function to persist a document.

App.vue
<script setup>
  import { initJuno, setDoc } from "@junobuild/core";
  import { onMounted, ref } from "vue";

  // TODO: Replace 'id' value with the satellite ID
  onMounted(
    async () =>
      await initJuno({
        id: "aaaaa-bbbbb-ccccc-ddddd-cai"
      })
  );

  const doc = ref(undefined);

  const insert = async () => {
    doc.value = await setDoc({
      collection: "demo",
      doc: {
        key: `my-key-${new Date().getTime()}`,
        data: {
          hello: "world"
        }
      }
    });
  };
</script>

<template>
  <button @click="insert">Insert a document</button>
  <span v-if="doc !== undefined">Key: {{ doc.key }}</span>
</template>

5. Start the app​

Start the app, go to http://localhost:5173 in a browser, click "Insert a document," and you should see the data successfully persisted in your satellite on the blockchain.

Note-taking app example​

This example demonstrates how to quickly deploy a basic note-taking app that integrates Juno's core features:

  • Authentication: easy-to-use SDKs that support truly anonymous authentication.
  • Datastore: a simple key-pair database for storing user data and other information.
  • Storage: a file storage system to store and serve user-generated content, such as photos.

Using the Juno CLI, you can easily scaffold this app. To start, run the appropriate command based on your package manager:

NPM:

npm create juno@latest

Yarn:

yarn create juno

PNPM:

pnpm create juno

Follow the CLI prompts to choose the note-taking app example and select local development. The CLI will manage all configurations and dependencies, allowing you to focus on exploring and customizing your app right away.

Hosting​

If you're looking to deploy your existing app or website developed with Vue and Juno, this guide is for you.

1. Set up a satellite​

If you haven't created a satellite yet, go ahead and create a new one in the Juno's console.

2. Install Juno CLI and log in​

Install the Juno command line interface by executing the following command in your terminal:

npm i -g @junobuild/cli

After the CLI is ready, log in to your satellite from your terminal to authenticate your device.

juno login

3. Deploy​

Build your app:

npm run build

Deploy your project by running the following command from your project’s root folder:

juno deploy

When prompted to provide the name or path of the folder containing your built dapp files, answer dist.

4. Open​

Open your browser and you should see your deployed app or website.

juno open