Skip to content

Getting Started ​

This section installs PortBay and adds your first project. Most people install the signed macOS app; contributors can also build from source.

Flow ​

  1. Install PortBay — the Homebrew cask or the DMG (see Install).
  2. Launch the app and let it set up its bundled sidecars on first run.
  3. Add a project from a local folder.
  4. Start the project and open its generated local .test URL.

What it looks like ​

PortBay managing local projectsPortBay managing local projects

The pages below walk through each step with screenshots and the expected state changes.

Next ​

Was this helpful?
Feedback

PortBay is pre-MVP software. Use the docs as an operating guide, not a stability guarantee.