Getting Started

Using Vexilla is a fairly easy process. There are a few steps to take care of before you are up and running, though.

You will need to use the App to set up your flags. You will also be responsible for hosting the JSON file anywhere that your application can access it. This means you can have it on any public file server, a CDN, or even privately hosted in a VPC.

Head over to the application and start creating your Flag Groups, Environments, and Flags. For more information about how to use the app, see (the guide)[/guides/application].

The first step is to install an SDK into your application. Vexilla supports many languages as first-party solutions. Just copy and paste this install command into your terminal and run it.

npm install @vexilla/client
// or
yarn add @vexilla/client
// or
pnpm add @vexilla/client

Vexilla is also open to third-party integrations. If you would like help in creating one, please check the documentation on GitHub. [TODO]

No third-party integrations found, yet.

Once your SDK is installed, you can begin using the client in your app.

// create client
const client = new VexillaClient({
  baseUrl: "http://localhost:3000",
  environment: "dev",
  customInstanceHash: "YOUR_USERS_ID",
});

//sync manifest
await client.syncManifest();

//sync flags
await client.syncFlags("FLAG_GROUP_NAME_OR_ID", (url) => {
  return fetch(url).then((response) => response.json());
});

After the client is set up, you can start using it in your application logic.

if (client.should("GROUP_NAME_OR_ID", "FLAG_NAME_OR_ID")) {
  // do something
}

Take a look through the guides provided.

Next Post
Core Concepts