featurevisor-example-cloudflare

Example Featurevisor project using Cloudflare Pages.

For more documentation, visit featurevisor.com.

Accessing datafiles

The generated target datafiles from this repository are available at these URLs:

• production: https://featurevisor-example-cloudflare.pages.dev/production/featurevisor-tag-all.json
• staging: https://featurevisor-example-cloudflare.pages.dev/staging/featurevisor-tag-all.json

Usage with Featurevisor SDK

Install the SDK in your application:

npm install @featurevisor/sdk

Then use it in your application:

import { createFeaturevisor } from "@featurevisor/sdk";

const DATAFILE_URL =
  "https://featurevisor-example-cloudflare.pages.dev/production/featurevisor-tag-all.json";

const datafileContent = await fetch(DATAFILE_URL).then((res) => res.json());

const sdk = createFeaturevisor({
  datafile: datafileContent,
});

Learn more about SDK usage here.

Installation

npm ci

Usage

Lint YAMLs

npx featurevisor lint

Build datafiles

npx featurevisor build

Review the output in the datafiles directory.

Test features

npx featurevisor test

Explore the Catalog

npx featurevisor catalog

Cloudflare

For this example, we are going to be uploading to and serving our datafiles from Cloudflare Pages.

Make sure you already have a Cloudflare Pages project set up, and then use it in the publish workflow.

GitHub Actions

This example project is configured to run its CI/CD pipeline with GitHub Actions.

You can use another CI/CD provider if preferred.

Settings

Make sure you have Read and write permissions enabled in your GitHub repository's Settings > Actions > General > Workflow permissions section.

Workflows

You can find the GHA workflow files in .github/workflows directory.

• checks workflow: runs against non-master (non-main) branches
• publish workflow: runs against master (main) branch

Secrets

Follow the Cloudflare guide and add these secrets under Settings > Secrets and variables > Actions:

• CLOUDFLARE_ACCOUNT_ID
• CLOUDFLARE_API_TOKEN

License

MIT © Fahad Heylaal