Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Code Issues Projects Releases Wiki Activity
Unleash is the open source feature toggle service.
601 Commits 468 Branches 865 Tags 314 MiB
TypeScript 91.5%
MDX 4.3%
JavaScript 3%
Mustache 0.8%
CSS 0.2%
173bcd9bc1
Go to file
ivaosthu 173bcd9bc1 Docs wip
2020-02-20 08:30:41 +01:00
bin only one level of creating options 2020-02-20 08:30:41 +01:00
docs Docs wip 2020-02-20 08:30:41 +01:00
lib more tests 2020-02-20 08:30:41 +01:00
migrations remove all lerna stuff 2020-02-20 08:30:37 +01:00
scripts remove all lerna stuff 2020-02-20 08:30:37 +01:00
test more tests 2020-02-20 08:30:41 +01:00
.editorconfig
.eslintignore
.eslintrc remove all lerna stuff 2020-02-20 08:30:37 +01:00
.gitignore use ava as testrunner 2020-02-20 08:30:39 +01:00
.travis.yml send coverage after success 2020-02-20 08:30:39 +01:00
LICENSE
migrator.js use options obj 2020-02-20 08:30:39 +01:00
package.json Server Metrics: add response time and status codes 2020-02-20 08:30:40 +01:00
Procfile Update Procfile 2020-02-20 08:30:38 +01:00
README.md readme 2020-02-20 08:30:41 +01:00
server.js cleanup bin 2020-02-20 08:30:40 +01:00

README.md

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

Build Status Coverage Status Dependency Status devDependency Status Admin UI 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:

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

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