Welcome to FeaturePeek! We're happy to augment your web development workflow. Integrating with FeaturePeek is a snap — there are only a few steps to get your team up and running.
At a high level, here are the steps you need to take to get your feature environments running on FeaturePeek:
- Create a FeaturePeek account. New teams start with a free two-week trial.
- Install our GitHub App on any organization you'd like to integrate with FeaturePeek.
- Add a
peek.yamlfile to the root of any project you'd like to add to FeaturePeek.
- Ping FeaturePeek after your build phase in CI.
That's it! You should now be able to automatically spin up feature environments every time you open a pull request.
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 front-end architecture that is neither static nor Dockerized, please let us know.
We support the following Continuous Integration services:
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.
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.
- You must whitelist
*.featurepeek.comfor any CORS requests.
- To fetch data from a backend service, use environment variables.
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.