Skip to content

Quickstart in an Amp orb

An Amp orb is the fastest way to run the portal. The repository declares everything the orb needs:

File What it does
.agents/setup Installs Postgres, creates the factory and factory_test databases, and installs the backend and frontend dependencies. Safe to run again.
.amp/services.yaml Declares the api, web and docs services, their ports, health check and portals.
  1. Add the GitHub settings to the project. Register the apps with GitHub apps, then add the values from Configuration as Amp project environment variables and secrets. .amp/services.yaml sets DATABASE_URL and APP_BASE_URL for you.

  2. Start the services.

    Terminal window
    amp orb services ensure

    This starts:

    Service Directory Port Portal
    api backend/ 8000 none; the web app proxies /api to it
    web frontend/ assigned Software Factory
    docs docs/ assigned MateFactory docs

    The api service runs alembic upgrade head before it starts, so the database is always at the latest migration.

  3. Open the Software Factory portal and click Sign in with GitHub.