Groundfloor Docs

Quick Start

Create an account, set up a workspace, and explore the Customer Portal in five steps.

Get from zero to a working workspace in the Customer Portal.

Sign in to the Customer Portal

Go to app.groundfloor.cloud and sign in with your Keycloak credentials.

If you don't have an account, ask your Groundfloor operator to provision one via POST /v1/admin/accounts.

Open your account

After sign-in, you'll land on your account dashboard. Confirm you see your account name and at least one workspace (or an empty workspace list).

Create a workspace

  1. Click Workspaces in the sidebar
  2. Click Create workspace
  3. Enter a name (e.g. Development)
  4. Confirm

The workspace UUID appears in the URL: /workspaces/{uuid}/…

Invite a team member

  1. Go to Users & Roles
  2. Click Invite user
  3. Enter their email and assign a role (owner, admin, or member)

They'll receive an invite and get workspace-scoped ReBAC permissions on acceptance.

Explore a pillar

Pick any live pillar from the sidebar — Activity Log is a good first choice. You'll see audit events for actions in your workspace.

For developers: note the workspace UUID — you'll need it for API calls and Shell app registration.

Local development

To run the full stack locally:

# Control Plane + Portal
cd groundfloor-client-portal
make compose-up          # Postgres, SpiceDB, MinIO, etc.
npm run dev:customer     # Customer Portal on :3000

API defaults to http://localhost:8088. See the Control Plane repo README for full setup.

Next steps

On this page