Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
Unleash is the open source feature toggle service.
533 Commits 481 Branches 871 Tags 357 MiB
TypeScript 92.2%
MDX 4.2%
JavaScript 2.5%
Mustache 0.8%
CSS 0.2%
2e4b525361
Go to file
ivaosthu 2e4b525361 Allow tests to be executed in docker. 
Not everyone wants to install postgres locally just to run our
tests. Added a small script which allows the developer to run
test via docker instead:

npm run test:docker

closes #146
2020-02-20 08:30:37 +01:00
docs wip docs 2020-02-20 08:30:35 +01:00
packages Allow tests to be executed in docker. 2020-02-20 08:30:37 +01:00
.codeclimate.yml Create .codeclimate.yml 2020-02-20 08:30:36 +01:00
.editorconfig eslint config 2020-02-20 08:30:26 +01:00
.eslintignore add eslintignore 2020-02-20 08:30:27 +01:00
.eslintrc eslint config 2020-02-20 08:30:26 +01:00
.gitignore fix frontend and fix deploy to dev-master with lerna 2020-02-20 08:30:27 +01:00
.travis.yml use lerna for multipackaging 2020-02-20 08:30:26 +01:00
lerna.json Upgrade and fix lint 2020-02-20 08:30:33 +01:00
LICENSE
package.json update aslant 2020-02-20 08:30:35 +01:00
Procfile fix frontend and fix deploy to dev-master with lerna 2020-02-20 08:30:27 +01:00
README.md Update README.md 2020-02-20 08:30:37 +01:00

README.md

unleash

__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 __

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:

Project details

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

$ docker-compose build
$ docker-compose up

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 (via unleash-api)
npm run db-migrate
DATABASE_URL=$TEST_DATABASE_URL npm run db-migrate

// Start server
npm start

// Admin dashboard
http://localhost:4242

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

// Execute tests in all packages:
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('../scripts/migration-runner').create('NNN-your-migration-name');
  4. Run db-migrate up.
  5. Generate LB artifact using scripts/generate-liquibase-artifact (TODO: make this internal)

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.

npm run publish:dry