1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/README.md

92 lines
3.3 KiB
Markdown
Raw Normal View History

# unleash
2014-11-10 16:25:22 +01:00
2016-06-18 11:52:51 +02:00
__Warning: We are in the process of splitting up unleash into multiple packages in this repository, if you want to test the previous package see [previous tag](https://github.com/finn-no/unleash/tree/v1.0.0-alpha.2) __
2016-06-18 11:36:50 +02: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.svg?branch=master)](https://coveralls.io/r/finn-no/unleash?branch=master)
[![Dependency Status](https://david-dm.org/finn-no/unleash.svg)](https://david-dm.org/finn-no/unleash)
[![devDependency Status](https://david-dm.org/finn-no/unleash/dev-status.svg)](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
[Demo](http://unleash.herokuapp.com/) instance on Heroku
2014-11-10 16:39:17 +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.
You find the docker files inside the `packages/unleash-docker` folder
2015-12-01 11:56:53 +01:00
```bash
$ docker-compose build
$ docker-compose up
```
2014-11-10 16:39:17 +01:00
## Development
### 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;
CREATE DATABASE unleash_test;
GRANT ALL PRIVILEGES ON DATABASE unleash_test to unleash_user;
2014-10-31 16:35:35 +01:00
SQL
```
Then set env vars:
2014-10-31 16:35:35 +01:00
```
export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
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
2016-06-18 11:36:50 +02:00
// Run migrations in your local DBs (via unleash-api)
npm run db-migrate
DATABASE_URL=$TEST_DATABASE_URL npm run db-migrate
2016-06-18 11:36:50 +02:00
// Start server
npm start
2014-10-31 16:35:35 +01:00
// Admin dashboard
http://localhost:4242
// Feature API:
http://localhost:4242/features
2016-06-18 11:36:50 +02:00
// Execute tests in all packages:
2014-10-31 16:35:35 +01:00
npm test
```
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.
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)
2016-06-18 11:36:50 +02:00
### Publishing / Releasing new packages
Please run `npm run nsp` nad `npm run lint` checks before publishing.
Run `npm run publish` to start the publishing process.
Lerna is setup with independent versioning so you will be prompted with version per package, and lerna will update all the versions across packages.
2016-06-18 11:52:51 +02:00
`npm run publish:dry`