Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Code Issues Projects Releases Wiki Activity
Unleash is the open source feature toggle service.
253 Commits 468 Branches 865 Tags 314 MiB
TypeScript 91.5%
MDX 4.3%
JavaScript 3%
Mustache 0.8%
CSS 0.2%
806da1eb44
Go to file
andsandv 806da1eb44 #80 Rename event ypes
2020-02-20 08:30:20 +01:00
lib #80 Rename event ypes 2020-02-20 08:30:20 +01:00
migrations Database migration #43 2020-02-20 08:30:19 +01:00
public #33 remove inline CSS 2020-02-20 08:30:20 +01:00
scripts Start postgres on random port in docker #64 2020-02-20 08:30:19 +01:00
test #33 Added unit test for createdBy 2020-02-20 08:30:20 +01:00
.editorconfig Add editorconfig 2020-02-20 08:30:20 +01:00
.gitignore Update .gitignore 2020-02-20 08:30:20 +01:00
.jshintrc
.travis.yml Using Travis new container-based stack 2020-02-20 08:30:19 +01:00
app.js When the user enters his username in to the field 2020-02-20 08:30:20 +01:00
artifact.json Add artifact.json 2020-02-20 08:30:20 +01:00
finnbuild.json Add build URL to finnbuild.json 2020-02-20 08:30:20 +01:00
jest-preprocessor.js Introduce jest as test-framework for gui code (react). 2020-02-20 08:30:18 +01:00
LICENSE
package.json #33 fix formatting package.json 2020-02-20 08:30:20 +01:00
README.md Improved README screenshot 2020-02-20 08:30:20 +01:00
server.js Split app and server. No need to start the server for these tests. 2020-02-20 08:30:18 +01:00
webpack.config.js fixed tabs->space 2020-02-20 08:30:14 +01:00

README.md

unleash

Build Status Code Climate Coverage Status Dependency Status devDependency Status

Admin UI

Demo instance on Heroku

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.

Known client implementations:

Development

Create a local unleash databases in postgres

$ 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;
SQL

Then set env vars:

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

Commands

// Install dependencies
npm install

// Run migrations in your local DBs
./node_modules/.bin/db-migrate up
DATABASE_URL=$TEST_DATABASE_URL ./node_modules/.bin/db-migrate up

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

// Admin dashboard
http://localhost:4242

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

// Execute tests:
npm test

// Run tests with postgres running in docker:
npm run docker-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 db-migrate up.
  5. Generate LB artifact using scripts/generate-liquibase-artifact (TODO: make this internal)