1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/unleash-server/README.md

46 lines
1.5 KiB
Markdown
Raw Normal View History

2014-10-24 13:44:43 +02:00
# unleash-server [![Build Status](https://travis-ci.org/finn-no/unleash.svg?branch=master)](https://travis-ci.org/finn-no/unleash) [![Code Climate](https://codeclimate.com/github/finn-no/unleash/badges/gpa.svg)](https://codeclimate.com/github/finn-no/unleash) [![Coverage Status](https://coveralls.io/repos/finn-no/unleash/badge.png?branch=master)](https://coveralls.io/r/finn-no/unleash?branch=master)
2014-09-30 10:07:40 +02:00
unleash-server is a place to ask for the status of features.
2014-10-23 14:36:06 +02:00
### Create a local unleash-db on postgres
2014-10-23 16:21:23 +02:00
```bash
2014-10-23 14:36:06 +02:00
$ psql postgres <<SQL
CREATE USER unleash_user WITH PASSWORD 'passord';
CREATE DATABASE unleash;
GRANT ALL PRIVILEGES ON DATABASE unleash to unleash_user;
SQL
2014-10-23 16:21:23 +02:00
```
2014-10-23 14:36:06 +02:00
Then set up your DATABASE_URI env.var:
```
export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
```
## Important commands:
```
2014-10-23 14:36:06 +02:00
// Make sure DATABASE_URL is set and run migrations in your local DB
db-migrate up
2014-10-20 14:11:26 +02:00
2014-10-20 17:46:41 +02:00
// Start server in dev-mode:
npm run start-dev
2014-10-20 17:46:41 +02:00
// Admin dashboard
http://localhost:4242
2014-10-20 17:46:41 +02:00
// Feature API:
http://localhost:4242/features
2014-10-20 17:46:41 +02:00
// Execute tests:
npm test
2014-10-20 17:46:41 +02:00
```
## 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 run the above SQL files.
4. Run `npm run db-migrate-up`.
5. Generate LB artifact using `scripts/generate-liquibase-artifact` (TODO: make this internal)
2014-10-23 10:32:13 +02:00