Skip to content

docs(start): make the quickstart work on its first run - #46

Merged
Bccorb merged 1 commit into
mainfrom
docs/quickstart-first-run
Oct 5, 2026
Merged

Bccorb merged 1 commit into
mainfrom
docs/quickstart-first-run

Conversation

@Bccorb

@Bccorb Bccorb commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Closes #44. Supersedes #18.

The quickstart failed on its first run. Every change below was checked against main in seamless-cli, seamless-templates, seamless-auth-server and seamless-auth-api.

First admin

bootstrap-admin no longer exists in the CLI. init asks for an owner email and writes it to the auth server as OWNER_EMAIL, and the account created with that address gets admin:write and admin. The quickstart, first admin guide, CLI pages, deploy page and ecosystem page now describe that, including that the grant only happens at signup.

CLI

  • Removed the npx seamless-cli my-app shorthand. The CLI rejects a bare project name as an unknown command.
  • CLI reference: managed init is documented as shipped (it was a half-merged "planned" paragraph), templates and apps are added, login (portal) is separated from profile login (instance), and the non-empty directory behaviour matches the code.
  • Removed the "Copy this into ChatGPT" prompts.

Local OTP and console

  • The quickstart and first user guide say exactly where the code appears: docker compose logs -f api, a line like Dev OTP for you@example.com: 123456.
  • The admin console defaults to http://localhost:3000/console, or :5174 with a separate dashboard container.

Managed quickstart

  • The React SDK's apiHost pointed at the hosted Auth Server URL. The SDK calls /auth/* on an adapter and relies on cookies, and the auth API serves neither, so sign-in could not work. The backend step now comes first and the frontend points at the developer's backend, with a caution against the old value. choose-your-path.mdx had the same row.
  • The Express snippet passed issuer, which is not in SeamlessAuthServerOptions, so it failed to compile in TypeScript. Removed.
  • Added CORS with credentials, without which a frontend on another port cannot send the session cookies.
  • Says where JWKS_KID comes from.

Checks

npm run lint, npm run typecheck (0 errors), npm run build and prettier all pass. Not yet run end to end on a clean machine.

Replace the removed bootstrap-admin command with the OWNER_EMAIL owner
grant, drop the bare project-name shorthand the CLI now rejects, say where
the local OTP appears, and point the managed quickstart's React SDK at the
developer's backend instead of the auth server.

Closes #44
@Bccorb
Bccorb merged commit 40e688d into main Oct 5, 2026
1 check passed
@Bccorb
Bccorb deleted the docs/quickstart-first-run branch October 15, 2026 03:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(start): quickstart fails on its first run

1 participant