Introduction

Welcome to FeaturePeek! We're happy to augment your web development workflow. Integrating with FeaturePeek Teams is a snap — there are only a few steps to get your team up and running.

Overview

At a high level, here are the steps you need to take to get your deployment previews running on FeaturePeek Teams:

  1. Create a FeaturePeek account. New teams start with a free two-week trial.
  2. Install our GitHub App on any organization you'd like to integrate with FeaturePeek.
  3. Add a peek.yml file to the root of any project you'd like to add to FeaturePeek.
  4. Ping FeaturePeek after your build phase in CI.

That's it! You should now be able to automatically create deployment previews every time you open a pull request.

Requirements

As of the time of writing, FeaturePeek supports static and Dockerized projects on GitHub only. If you are using a different service like GitLab or BitBucket, or if you have a frontend architecture that is neither static nor Dockerized, please let us know.

We currently support the following Continuous Integration services (services without links are supported but undocumented):

And the following container registries:

If you are using any other service not mentioned above, please let us know. This will help us prioritize which services to integrate with next.

Sample code and demos

Check out the FeaturePeek org on GitHub for a list of sample code repos. Each example- project is a frontend project hooked up to a different continuous integration service. You can search the list of repositories to find a frontend project that matches your own. Take a look at the open pull requests too — they link to a running, public FeaturePeek deployment.

You can also view a demo of the dashboard without creating a FeaturePeek account.

Troubleshooting

A few of the common gotchas are easily fixable — you just have to know what to look for.

  • Your app must be allowed to run inside a frame. This means disabling any frame-busting scripts, and ensuring that you aren't sending the X-Frame-Options response header. All FeaturePeek deployments have the FEATUREPEEK_HOST environment variable present, which you can use to conditionally turn off certain response headers.
  • You must whitelist your project's Origin URI on your backend for any CORS requests or OAuth callbacks to be successful. You can find this URI in your project settings, or in the settings in your deployment's FeaturePeek drawer.
  • To fetch data from a backend service, it's recommended to save your API's base URL as an environment variable — that way you can change the value depending on whether your app is running on FeaturePeek or in production. You can edit your environment variables in your project settings, or in the settings in your deployment's FeaturePeek drawer.

For more detail, read our Troubleshooting chapter.

If you are still having trouble getting your project set up on FeaturePeek, feel free to schedule an appointment with us. We can help you out no matter the problem or project.