Flag Management

Getting Started

Preparations

Install libpq and ensure it is in the path and available to compilers.

brew install libpq

# Add Homebrew libpq settings to ~/.zshrc
export PATH="/opt/homebrew/opt/libpq/bin:$PATH"
export LDFLAGS="-L/opt/homebrew/opt/libpq/lib:$LDFLAGS"
export CPPFLAGS="-I/opt/homebrew/opt/libpq/include:$CPPFLAGS"

Install knex and vitest globally.

npm install knex vitest @vitest/ui -g

First Run...

• Setup your NPM_TOKEN...
  • Copy .env.example to .env with cp .env.example .env
  • Replace somestringvalue in .env with your NPM token.
  • Ensure that NPM_TOKEN is exported in your shell (~/.zshrc or ~/.zshprofile).
    • NPM_TOKEN=yourtokenfromnpmui
• Run NPM install - npm i --workspaces
• Build the generic containers for clients and services (to speed up later builds)...
  • docker build -t emarsys/fastify-server --build-arg NPM_TOKEN=$NPM_TOKEN ./docker/fastify-server
  • docker build -t emarsys/vue-client --build-arg NPM_TOKEN=$NPM_TOKEN ./docker/vue-client
• Start the database instance (and create the databases)... docker compose up -d db
• Migrate the databases to their latest version... npm run knex migrate:latest --workspaces --if-present
• Load database seeds for teams... npm run knex seed:run --workspace=packages/team-service
• Load database seeds for flags... npm run knex seed:run --workspace=packages/flag-management-service
• Start the API and Client services... docker compose up -d

Flag Types

• Flipper - "feature toggle" with an expiration date.
• Feature - "permission toggle"