mirror of
https://github.com/Unleash/unleash.git
synced 2026-09-25 11:52:07 +00:00
86e168ec841f14ee09333dddbfd2b1bb443aa328
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.sqlwith your change in SQL. - Create
migrations/sql/NNN-your-migration-name.down.sqlwith the rollback of your change in SQL. - Run
db-migrate create your-migration-nameand edit the generated file to have this line:module.exports = require('../lib/migrationRunner').create('NNN-your-migration-name'); - 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:
Description
Languages
TypeScript
97%
JavaScript
2.2%
Mustache
0.6%