Get up and running in no time.

Follow these four steps.

Setup instructions

From static builds to Docker containers, FeaturePeek supports various types of front-end architectures.

  • 1. Install our GitHub App on your org
  • 2. Check-in a file to your repo root
  • 3. Ping our service after your build phase in CI
  • 4. Open a new pull request and celebrate 馃帀
Install our GitHub App

Install our app on your GitHub organization. This lets us listen to webhooks and gives us permission to comment on your pull requests.

Add a peek.yaml file to your repo root

Check-in a file to your repo root. For each project you want on FeaturePeek, check-in a peek.yaml file to your repo root. You can track an unlimited number of projects on FeaturePeek.

Ping our service after your build phase in CI

Ping our service after your build phase. Tell us when your pull request builds are ready by pinging our service. We have a build dependency for a number of CI platforms that makes this as easy as adding a few lines.

Open up a new pull request

Open a new pull request. That's it! Every new pull request opened will have a corresponding FeaturePeek environment. Once you merge it in, every new branch will be able to use our suite of collaboration tools.

Video walkthrough

Watch FeaturePeek in action.

Product FAQs

Do people on FeaturePeek team need to be in my GitHub org?

Nope! You can invite anyone you'd like to your FeaturePeek team, and they'll have access to your running environments. Our GitHub App can even comment on pull requests on their behalf, so they'll stay in the conversation.

Do I need to containerize with Docker on my own?

Not at all. If you're building static assets, just use our build-time dependency in CI and we'll do all the dirty DevOps work for you.

My project is a monorepo. How do I integrate with FeaturePeek?

You can integrate your front-end within your monorepo the same as you'd integrate any front-end. For the backend, we recommend using environment variables to point to existing backend services.

When will {X} Continuous Integration service be supported?

As of writing, we have the most support for CircleCI, and are supporting more every week.

Request your free trial today.