Skip to main content

Getting Started

Flagbase Core is the main service responsible for streaming feature flags to our SDKs via SSE (Server-Sent Events). It provides a REST API, used to manage key resources (i.e. workspaces, projects, environments, flags etc).

The core has multiple modes of operation (i.e. api, streamer, polling, all (default)). The service can be run on multiple nodes (i.e. horizontally scalable).

Quick Start​

The quickest way to get the service running locally will require you to have docker and docker-compose installed on your machine. If you want help compiling the binary and running locally, please use the Core Dev Guides.

  1. Getting the source code
git clone git@github.com:flagbase/flagbase.git
cd flagbase/core
  1. Starting up services
docker-compose up
  1. Creating a root user
docker-compose exec core ./bin/flagbased manage access create --key=<ACCESS_KEY> --secret=<ACCESS_SECRET> --type=root
  1. Check that it's working
curl -P GET http://localhost:5051/healthcheck

Remove all containers and volumes (fresh-start)​

docker-compose down -v

Contributing​

We encourage community contributions via pull requests. Before opening up a PR, please read our contributor guidelines.

Resources​

Check out these pages that'll help you get started, if you want to contribute to the core: