Groundfloor Docs
Shell apps

Overview

Build a web app that runs in your workspace's Shell site, with sign-in, users, data, files and feature flags built in.

A Shell app is a React web app that runs inside your workspace's Shell site. The Shell provides the frame around it: sign-in, navigation, your theme and the connection to Groundfloor. Your app provides the pages. You don't build sign-in, a user system or a backend for data.

Where it runs

Every workspace has a Shell site. Each Shell app has its own path on it:

https://<workspace-slug>.app.groundfloor.cloud/apps/<app-slug>/<page>

The workspace can also use its own subdomain or domain; see App authentication.

What's built in

You needBuilt inGuide
Your users to sign inThe Shell signs them in and gives your app their tokenSign-in and users
To store and query dataRead and write your workspace's dataData
To upload and download filesWorkspace file storageFiles
To switch features on and offPer-environment feature flagsFeature flags
AI models, API keys, server-side workA Coderunner backend that your app callsSecrets and backends

How you build one

  1. Get the starter kit — a ready-made React, Vite and Tailwind project, with helpers for everything above.
  2. Preview it locally with npm run dev, against your workspace's real data.
  3. Publish a release with npm run release and gf apps publish.
  4. Open it on your Shell site.

Build your first Shell app walks through these steps. You can also work without installing anything: Develop online, on the app's page in the Client Portal, opens the starter kit in a development environment in your browser.

Next steps

On this page