2015-01-23 12:19:54 +01:00
# unleash
2014-11-10 16:25:22 +01:00
[![Build Status ](https://travis-ci.org/finn-no/unleash.svg?branch=master )](https://travis-ci.org/finn-no/unleash) [![Code Climate ](https://codeclimate.com/github/finn-no/unleash/badges/gpa.svg )](https://codeclimate.com/github/finn-no/unleash) [![Coverage Status ](https://coveralls.io/repos/finn-no/unleash/badge.png?branch=master )](https://coveralls.io/r/finn-no/unleash?branch=master) [![Dependency Status ](https://david-dm.org/finn-no/unleash.png )](https://david-dm.org/finn-no/unleash) [![devDependency Status ](https://david-dm.org/finn-no/unleash/dev-status.png )](https://david-dm.org/finn-no/unleash#info=devD)
2014-11-06 09:29:03 +01:00
2015-01-23 12:21:33 +01:00
![Admin UI ](https://cloud.githubusercontent.com/assets/572/5873775/3ddc1a66-a2fa-11e4-923c-0a9569605dad.png )
2014-09-29 14:50:46 +02:00
2015-01-23 12:19:54 +01:00
[Demo ](http://unleash.herokuapp.com/ ) instance on Heroku
2014-11-10 16:39:17 +01:00
2015-01-23 12:19:54 +01:00
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.
2014-11-10 16:39:17 +01:00
Known client implementations:
- [unleash-client-java ](https://github.com/finn-no/unleash-client-java )
2015-03-11 08:57:29 +01:00
- [unleash-client-node ](https://github.com/finn-no/unleash-client-node )
2014-11-10 16:39:17 +01:00
2015-12-01 11:56:53 +01:00
## Run with docker
We have set up docker-compose to start postgres and the unleash server together. This makes it really fast to start up
unleash locally without setting up a database or node.
```bash
$ docker-compose build
$ docker-compose up
```
2014-11-10 16:39:17 +01:00
## Development
2014-12-12 14:11:09 +01:00
### Create a local unleash databases in postgres
2014-10-31 13:03:54 +01:00
2014-10-31 16:35:35 +01:00
```bash
$ psql postgres < < SQL
CREATE USER unleash_user WITH PASSWORD 'passord';
CREATE DATABASE unleash;
GRANT ALL PRIVILEGES ON DATABASE unleash to unleash_user;
2014-12-12 14:11:09 +01:00
CREATE DATABASE unleash_test;
GRANT ALL PRIVILEGES ON DATABASE unleash_test to unleash_user;
2014-10-31 16:35:35 +01:00
SQL
```
2014-12-12 14:11:09 +01:00
Then set env vars:
2014-10-31 16:35:35 +01:00
```
export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
2014-12-12 14:11:09 +01:00
export TEST_DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash_test
2014-10-31 16:35:35 +01:00
```
2014-11-10 16:39:17 +01:00
### Commands
2014-10-31 16:35:35 +01:00
```
// Install dependencies
npm install
2014-12-12 14:11:09 +01:00
// Run migrations in your local DBs
./node_modules/.bin/db-migrate up
2014-12-12 16:19:12 +01:00
DATABASE_URL=$TEST_DATABASE_URL ./node_modules/.bin/db-migrate up
2014-12-12 14:11:09 +01:00
2014-10-31 16:35:35 +01:00
// Start server in dev-mode:
2014-11-12 13:14:07 +01:00
npm run dev
2014-10-31 16:35:35 +01:00
// Admin dashboard
http://localhost:4242
// Feature API:
http://localhost:4242/features
// Execute tests:
npm test
2014-12-09 16:36:27 +01:00
// Run tests with postgres running in docker:
npm run docker-test
2014-10-31 16:35:35 +01:00
```
2014-11-10 16:39:17 +01:00
### Making a schema change
2014-10-31 16:35:35 +01:00
1. Create `migrations/sql/NNN-your-migration-name.up.sql` with your change in SQL.
2. Create `migrations/sql/NNN-your-migration-name.down.sql` with the rollback of your change in SQL.
2016-05-01 16:28:30 +02:00
3. Run `db-migrate create your-migration-name` and edit the generated file to have this line: `module.exports = require('../scripts/migration-runner').create('NNN-your-migration-name');`
2014-11-13 20:00:34 +01:00
4. Run `db-migrate up` .
2014-10-31 16:35:35 +01:00
5. Generate LB artifact using `scripts/generate-liquibase-artifact` (TODO: make this internal)