Get up and running in no time.
Follow these four steps.
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 app on your GitHub organization. This lets us listen to webhooks and gives us permission to comment on your pull requests.
Check-in a file to your repo root. For each project you want on FeaturePeek, check-in a peek.yml file to your repo root. You can track an unlimited number of projects on FeaturePeek.
Ping our service after your build phase. Tell us when your pull request builds are ready by pinging our service. Our single-line command works with a number of CI platforms and container registries.
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.
How does this work with front-ends that require backend services to display correctly?
You can set environment variables to be the base URL of existing backend services that you host. Each FeaturePeek team has a namespaced route that you can whitelist in order to circumvent any CORS issues.
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. In your peek.yml file, point to your static front-end build path relative to your repo root; or, if you use Docker, point to your front-end Dockerfile relative to your repo root.
Which Continuous Integration services and container registries are supported?
As of writing, we support Azure Pipelines, Buildkite, CircleCI, Codeship, Docker Cloud, Drone, Jenkins, Semaphore, and Travis; for container registries, we support Amazon ECR, DockerHub, and Google Container Registry.