Flagcontrol SDKs

This monorepo contains the official SDKs and tools for Flagcontrol.

Packages

| Package | Description | Version | |Ptr|---|---| | @flagcontrol/core | Core logic shared across SDKs | | | @flagcontrol/node | Node.js Server-side SDK | | | @flagcontrol/react | React Client-side SDK | | | flagcontrol | TypeScript definition generator | |

Getting Started

Please refer to the individual package READMEs for installation and usage instructions:

• Node.js SDK Documentation
• React SDK Documentation
• Generator Documentation

Development

This project is a monorepo managed with npm workspaces.

Prerequisites

• Node.js >= 18
• npm >= 9

Setup

1. Clone the repository:

   git clone https://github.com/flagcontrol/flagcontrol-sdks.git
   cd flagcontrol-sdks

2. Install dependencies:

   npm install

3. Build all packages:

   npm run build

Running Examples

The examples directory contains sample applications using the SDKs.

• Backend Example: examples/backend
• Frontend Example: examples/frontend

To run the backend example:

npm start -w examples/backend

To run the frontend example:

npm run dev -w examples/frontend

Building Packages Individually

npm run build -w packages/core

npm run build -w packages/node-sdk

npm run build -w packages/react-sdk

npm run build -w packages/generator

Publishing

npx changeset
npm run publish