unleash

Warning: We will soon release the first official version of Unleash (1.0.0). If you want to test the previous package see previous tag

Demo instance on Heroku

This repo contains the unleash-server, which contains the admin UI and a place to ask for the status of features. In order to make use of unleash you will also need a client implementation.

Known client implementations:

unleash-client-java
unleash-client-node
(you implementaiton here!)

Running Unleash

Requirements

You will need a PostreSQL 9.3+ database instance to be able to run Unleash.

When starting Unleash you must specify a database uri (can be set as environment variable DATABASE_URL) which includes a username and password, that have rights to migrate the database.

Unleash will, at startup, check whether database migration is needed, and perform necessary migrations.

Start Unleash

1. The simplest way to get started:

$ npm install unleash-server -g
$ unleash -d postgres://unleash_user:passord@localhost:5432/unleash -p 4242

Unleash started on port:4242

You can also require Unleash as a lib and expend it with more options. Read more about this feature in the getting started guide.

Project details

Project Roadmap

Developer Guide

If you want to contribute to this project you are encuraged to send issue request, or provie pull-requests. Please read the unleas developer guide to learn more on how you can contribute.

Run with docker

We have made a sperate project which runs unleash inside docker. Please see unelash-docker

2.5 KiB Raw Blame History