portal-setup

What problem does it solve?

Guides users through initializing and configuring a local Showpane workspace by detecting the app path, installing dependencies, applying the local SQLite Prisma schema, and creating a persisted organization record so the project can be previewed and deployed locally.

Core Features & Use Cases

• App detection and validation: searches common locations and validates package.json plus Prisma schema markers before proceeding.
• Dependency management: installs npm packages and generates the Prisma client when needed.
• Database provisioning: sources .env and applies the local SQLite schema using prisma db push.
• Organization and branding setup: interactively collects org name, contact info, slug, and primary color and writes a secure ~/.showpane/config.json.
• Robust error handling and telemetry: checks node/npm versions, database connectivity, file permissions, and records setup events for learnings or follow-up actions. Use case: a developer runs the packaged installer or npx showpane to quickly prepare a freshly generated Showpane project for local development and publishing.

Quick Start

Run the interactive setup by launching the portal-setup flow (for example via npx showpane) to detect your app, install dependencies, apply the local schema, and create the organization.