Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.74 KB

README.md

File metadata and controls

61 lines (44 loc) · 2.74 KB
Raw

Welcome Ninja!

This is the community repository for FeatureNinjas SaaS. Bugs and Features are openly shared here.

You want to define what feature comes next? Head over to our GitHub project board at https://github.com/orgs/FeatureNinjas/projects/1 and give feedback on the issues there.

To suggest new features or to report any bugs, create issues in this repository as you know from other GitHub projects.

Get Started

  1. Sign up for any FeatureNinjas plan at featureninjas.com
  2. Create a repository that will host your feature toggle configuration (if not done already). This can be public or private, be in a personal or organization account. (Note: You can use your projects source repository for the feature toggles as well, but we don't suggest to do so. Keep your configuration separate so that you can control who and when it is changed.)
  3. In your feature toggle repository, create a .featureninjas.yml configuration file. It controls what the name of the file is that contains the feature toggles, and gives you the ability to specify an optional read token that can be used to additionally secure the API.

Sample:

# Version information (is always 1.0)
version: 1.0

# (mandatory)
# Feature toggle file name
#   Contains the name of the file with the feature toggles.
file: fn-master.json

# (optional)
# Security Token
#   If this is set, then you have to provide this token via every request to
#   get your feature toggle configuration in the HTTPS header X-FeatureNinjas-Token
token: rtqoq85r1f6vejwuxtb1l
  1. Push a feature toggle configuration to your feature toggle repository. The name of the file is specified in the configuration file (see previous step).

Sample:

{
  "backupEnabled": true,
  "backupInterval": 10000,
  "backupFileFormats": "xlsx|psql|csv"
}

Have a look at the fn-sample-simple repository (https://github.com/FeatureNinjas/fn-sample-simple) for a very simple example of a feature toggle repository.

  1. Use a simple HTTPS GET command to access your feature toggles from anywhere.
curl -X GET \
  https://api.featureninjas.com/t/<account-name>/<repo-name>/<branch_ref_name> \
  -H 'X-FeatureNinjas-Token: <token>'

This request always returns json in the body. The 'Accept' header is ignored.