SynqDocs
Getting started

Getting started

Where to start with Synq for each kind of app.

Every app signs people in through one of your brands, at the brand's own issuer. To start, sign up, verify your email and make an org: its first brand's issuer works at once, on the free Starter plan. Then start from the kind of app you have.

Your appStart here
A Next.js app with the App RouterSigned up? In the app's folder, run the npx synqauth init --code … command from your app's Get started page in the dashboard: it signs people in to your brand at once, with nothing to claim. With no account yet, npx synqauth init gives the app a working development sign-in, which you claim later as a new organization or as a brand in one you own. Or follow Sign users in to a Next.js app step by step.
A single-page app in the browser, such as a Vite or React appRegister an spa app of your brand (Apps and APIs), then follow Sign users in with @synqauth/js: createSynqClient, the callback, the user and signing out, with a React example. Not @synqauth/react: its hooks and components need a route mount on your app's server, which @synqauth/nextjs serves, so they don't work in an app with no server.
A server of your own that isn't Next.jsA web app with its secret, and @synqauth/js on a server: routes that sign people in and out and keep each person's session on the server.
A React Native or Expo app@synqauth/react-native signs people in through the system browser and keeps the session in the device's secure storage.
Sign-in with a Solana walletSolana wallets on the hosted page, or @synqauth/solana from your app's own page.
Your own APICheck Synq's access tokens with createAccessTokenVerifier, from @synqauth/js's @synqauth/js/server entry.
Anything else that speaks OpenID ConnectPoint it at your brand's issuer, which publishes its endpoints at /.well-known/openid-configuration on its own host (Synq Docs).

Working examples

Synq's examples on GitHub are whole apps on the packages as npm has them, each with a README that says how to make its app in the dashboard first:

  • nextjs-solana-login: a Next.js App Router app with Sign In With Solana and passkeys on its own page, through @synqauth/nextjs.
  • expo-solana-login: an Expo app for Android and the Solana Seeker, which signs in with the phone's wallet app through Mobile Wallet Adapter, with no browser.

Try sign-in before your site is up

You can sign in to your brand before you write any code. On your app's page in the dashboard, Try sign-in, under Connect your app, opens your brand's hosted sign-in page in a new tab, as your users will see it. The top bar's Open sign-in page does the same from any page. Sign in, or sign up, and you land on Synq's own page, on your brand's issuer, saying it works and who signed in, with a link back to the dashboard.

The link works once, within 10 minutes. It registers nothing: no app, redirect URI or secret, so it works with no site at all. Its sign-ins count toward no monthly active user. It shows your brand's page with every way to sign in it offers: an app that takes only some of them offers just those once your site signs people in.

An AI agent connected to Synq's MCP server gets the same link with preview_sign_in (Use with an AI agent).

On this page