Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

More README tweaks

Browse Source
This commit is contained in:
Jari Bakken 2014-11-10 16:39:17 +01:00
parent 62f8c731d9
commit 4dbed0daf7
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,6 +4,15 @@
unleash-server is a place to ask for the status of features. unleash-server is a place to ask for the status of features.
## Clients
In order to make use of unleash you will probably need a client implementation.
Known client implementations:
- [unleash-client-java](https://github.com/finn-no/unleash-client-java)
## Development
### Create a local unleash-db on postgres ### Create a local unleash-db on postgres
```bash ```bash
@ -19,13 +28,14 @@ Then set DATABASE_URI env var:
export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
``` ```
## Important commands: ### Commands
``` ```
// Install dependencies // Install dependencies
npm install npm install
// Make sure DATABASE_URL is set and run migrations in your local DB // Make sure DATABASE_URL is set and run migrations in your local DB
export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
./node_modules/.bin/db-migrate up ./node_modules/.bin/db-migrate up
// Start server in dev-mode: // Start server in dev-mode:
@ -41,16 +51,10 @@ http://localhost:4242/features
npm test npm test
``` ```
## Making a schema change ### Making a schema change
1. Create `migrations/sql/NNN-your-migration-name.up.sql` with your change in SQL. 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. 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');` 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`. 4. Run `npm run db-migrate-up`.
5. Generate LB artifact using `scripts/generate-liquibase-artifact` (TODO: make this internal) 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:
- [unleash-client-java](https://github.com/finn-no/unleash-client-java)