Docs

Get started

Set up your organization

Verified against Soffi ·

Setting up Soffi means getting your app running in it once, so the rest of your team can start working the moment they join. It takes a few minutes of your time, and then about an hour of Soffi's while it builds and checks your app. This page is for the Owner or an Admin doing that first setup.

A few minutes of yours

  1. Step 1Connect your GitHub

  2. Step 2Install Soffi and connect repos

  3. Step 3Add your app's repos

  4. Step 4Build my app

Repos already in Soffi skip the GitHub steps.

About an hour
Soffi builds

Setting up your app

Soffi copies your repositories, creates the Project, works out how to run each part, builds the Data Twin, turns off sign-in for previews, and checks every screen has data.

Your app is ready to review

  • Review your app and click through it
  • Publish the Project so your team can start Workspaces
  • Invite your team
A few minutes of setup from you, then about an hour while Soffi builds and checks your app.

Before you start

Soffi creates your Organization for you and makes you its Owner, using the email address you gave us. Sign in with Google with that address at your Organization's address (for example acme.soffi.ai). If setup doesn't open on its own, choose Get started on the Workspaces page.

You'll need permission to install a GitHub app on the GitHub organization that owns your repositories. If someone else administers GitHub for you, have them nearby for the second step.

Only Admins and the Owner can run setup. Anyone else who signs in first sees a note that an admin is connecting your repositories, and can start working once the first Project is ready.

The steps

Connect your GitHub

Link your own GitHub account to Soffi. This lets Soffi list the repositories you can see, and later lets pull requests you Ship open under your own name.

Install Soffi and connect repos

Choose Install on GitHub, pick the GitHub organization, and select the repositories your app needs to run: your primary repo (usually the frontend), plus anything it depends on, like a design system, an admin panel, or a config repository. You can change this later from the Manage link on the same card, or from the GitHub app settings in Soffi.

Add your app's repos

Check the repositories that make up your app and choose which one is the Primary repo, the one Soffi runs and previews. Within a large repository you can check just the folders that matter. For each one, tell Soffi in a sentence how it fits: how the primary repo starts, or what a supporting repository provides. You can add anything else Soffi should know and upload files, such as setup notes.

Leave the Data Twin switch on if your app talks to a backend, so every screen renders with realistic data on the first run without touching your real services. See Data Twin.

Build my app

Choose Build my app. Soffi copies your repositories, creates the Project, and starts setting it up: working out how to run each part, building the Data Twin, turning off your app's own sign-in for previews, and checking that the app comes up with data on every screen.

If your Organization already has repositories in Soffi, the GitHub steps are skipped and you start at Add your app's repos.

While Soffi builds

Building usually takes about an hour, and you can close the page and come back. Watch Soffi set it up opens your new Project's setup, where you can follow Soffi's progress and answer her if she needs something from you. This is also a good time to connect Figma, Linear, or Jira from the cards below, so Soffi can use your designs and tickets as context.

When the app is ready, the page says Your app is ready to review. If setup stops, it says Your app needs attention, explains why, and offers the next step, such as continuing where Soffi left off or answering a question.

When it's ready

Open the app with Review your app and click through it. When it runs the way it should, publish the Project. Until you do, nobody else in your Organization can start a Workspace from it. See Publish a project.

Then invite your team. To run another app in Soffi, choose Set up another app at the end of setup, or New project on the Projects page.

Start over disconnects GitHub from Soffi and signs you out. It doesn't uninstall the Soffi app from GitHub; remove it there if you want to.

Was this helpful?