1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Unleash is the open source feature toggle service.
Go to file
2014-11-10 16:25:22 +01:00
lib Reduce duplication when adding a new migration. 2014-11-10 15:58:11 +01:00
migrations Reduce duplication when adding a new migration. 2014-11-10 15:58:11 +01:00
public README cleanup 2014-11-10 16:25:22 +01:00
scripts Move unleash-server to top level. 2014-10-31 16:35:35 +01:00
test added server side validation of feature name 2014-11-01 11:47:21 +01:00
.gitignore added server side validation of feature name 2014-11-01 11:47:21 +01:00
.jshintrc Move components to separate files. 2014-10-30 18:26:51 +01:00
.travis.yml Fix .travis.yml 2014-10-31 16:36:42 +01:00
finnbuild.json Move unleash-server to top level. 2014-10-31 16:35:35 +01:00
LICENSE Update LICENSE 2014-09-29 16:46:35 +02:00
package.json Modified configuration to make it run on heroku. 2014-11-06 22:42:57 +01:00
README.md README cleanup 2014-11-10 16:25:22 +01:00
server.js Modified configuration to make it run on heroku. 2014-11-06 22:42:57 +01:00
webpack.config.js fixed tabs->space 2014-11-06 22:45:17 +01:00

unleash-server

Build Status Code Climate Coverage Status Dependency Status devDependency Status

unleash-server is a place to ask for the status of features.

Create a local unleash-db on postgres

$ psql postgres <<SQL
CREATE USER unleash_user WITH PASSWORD 'passord';
CREATE DATABASE unleash;
GRANT ALL PRIVILEGES ON DATABASE unleash to unleash_user;
SQL

Then set DATABASE_URI env var:

export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash

Important commands:

// Install dependencies
npm install

// Make sure DATABASE_URL is set and run migrations in your local DB
./node_modules/.bin/db-migrate up

// Start server in dev-mode:
npm run start-dev

// Admin dashboard
http://localhost:4242

// Feature API:
http://localhost:4242/features

// Execute tests:
npm test

Making a schema change

  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('../lib/migrationRunner').create('NNN-your-migration-name');
  4. Run npm run db-migrate-up.
  5. Generate LB artifact using scripts/generate-liquibase-artifact (TODO: make this internal)

Clients

In order to make use of unleash you will probably need a client implementation.

Known client implementations: