mirror of https://github.com/Unleash/unleash.git synced 2025-01-11 00:08:30 +01:00

Unleash is the open source feature toggle service.

activation-strategies continuous-delivery continuous-deployment devops devtool experiments feature feature-flags feature-toggle feature-toggles feature-toggling hacktoberfest toggles unleash variants

Go to file

Ivar Østhus ca78acd25e Modified configuration to make it run on heroku. Please note that scripts and webpack is moved from devDependences to dependencies. This is due to heroku running the build process in production mode.		2020-02-20 08:30:14 +01:00
lib	Strategies should also have description #34	2020-02-20 08:30:14 +01:00
migrations	Move unleash-server to top level.	2020-02-20 08:30:13 +01:00
public	Modified configuration to make it run on heroku.	2020-02-20 08:30:14 +01:00
scripts	Move unleash-server to top level.	2020-02-20 08:30:13 +01:00
test	added server side validation of feature name	2020-02-20 08:30:13 +01:00
.gitignore	added server side validation of feature name	2020-02-20 08:30:13 +01:00
.jshintrc	Move components to separate files.	2020-02-20 08:30:12 +01:00
.travis.yml	Fix .travis.yml	2020-02-20 08:30:13 +01:00
finnbuild.json	Move unleash-server to top level.	2020-02-20 08:30:13 +01:00
LICENSE
package.json	Modified configuration to make it run on heroku.	2020-02-20 08:30:14 +01:00
README.md	badgify v2	2020-02-20 08:30:14 +01:00
server.js	Modified configuration to make it run on heroku.	2020-02-20 08:30:14 +01:00
webpack.config.js	Modified configuration to make it run on heroku.	2020-02-20 08:30:14 +01:00

README.md

unleash-server

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 up your 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

Create migrations/sql/NNN-your-migration-name.up.sql with your change in SQL.
Create migrations/sql/NNN-your-migration-name.down.sql with the rollback of your change in SQL.
Run db-migrate create your-migration-name and edit the generated file to run the above SQL files.
Run npm run db-migrate-up.
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:

unleash-client-java