Get Started

This guide walks you through creating a YouCan app from scratch and installing it on your development store.

Prerequisites

• A YouCan Partner account
• A development store set up
• Node.js and pnpm installed

1. Create your app

Run the following command to scaffold a new YouCan app:

pnpm create @youcan/app@latest

You'll be prompted to name your app. The command sets up everything — dependencies, configuration, and environment — automatically.

TIP

We recommend the Nuxt template as it comes pre-configured with authentication, session handling, and the full development stack.

2. Start the development server

cd <your-app-name>
pnpm dev

The CLI will prompt you to log in to your YouCan store if you haven't already. Once authenticated, your app will be running locally and tunneled to a public URL.

3. Install the app on your development store

With the dev server running, press P in your terminal.

This will automatically open an installation URL you can complete through the Seller Area. Once installed, your app will appear in the sidebar for testing.

This opens an installation URL you can complete through the Seller Area. Once installed, your app will appear in the sidebar for testing.

Next steps

• Authentication — understand how sessions and tokens work
• Build an app using Nuxt — full walkthrough with orders and webhooks
• Qantra — interact with the Seller Area from your app