mirror of
				https://github.com/Unleash/unleash.git
				synced 2025-10-27 11:02:16 +01:00 
			
		
		
		
	Move unleash-server to top level.
This commit is contained in:
		
							parent
							
								
									9639aef932
								
							
						
					
					
						commit
						f06a4a8a51
					
				
							
								
								
									
										14
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										14
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @ -27,14 +27,12 @@ node_modules | |||||||
| # Users Environment Variables | # Users Environment Variables | ||||||
| .lock-wscript | .lock-wscript | ||||||
| 
 | 
 | ||||||
| # Idea stuff |  | ||||||
| .idea |  | ||||||
| *.iml |  | ||||||
| 
 |  | ||||||
| # Java |  | ||||||
| target |  | ||||||
| 
 |  | ||||||
| # webpack output | # webpack output | ||||||
| /unleash-server/public/js/bundle.js | public/js/bundle.js | ||||||
| 
 | 
 | ||||||
| .DS_Store | .DS_Store | ||||||
|  | 
 | ||||||
|  | # liquibase stuff | ||||||
|  | /sql | ||||||
|  | unleash-db.jar | ||||||
|  | unleash-server.tar.gz | ||||||
							
								
								
									
										49
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										49
									
								
								README.md
									
									
									
									
									
								
							| @ -1,7 +1,48 @@ | |||||||
| # [unleash](http://finn-no.github.io/unleash/) [](https://travis-ci.org/finn-no/unleash) [](https://coveralls.io/r/finn-no/unleash?branch=master) | # unleash-server [](https://travis-ci.org/finn-no/unleash) [](https://codeclimate.com/github/finn-no/unleash) [](https://coveralls.io/r/finn-no/unleash?branch=master) | ||||||
|  | unleash-server is a place to ask for the status of features. | ||||||
| 
 | 
 | ||||||
| feature toggle service | ### Create a local unleash-db on postgres | ||||||
| 
 | 
 | ||||||
|  | ```bash | ||||||
|  | $ 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 | ||||||
|  | 
 | ||||||
|  | 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) | ||||||
| 
 | 
 | ||||||
| ## Unleash clients |  | ||||||
| * [unleash-client-java](http://github.com/finn-no/unleash-client-java) |  | ||||||
|  | |||||||
| @ -10,10 +10,10 @@ | |||||||
|   }, |   }, | ||||||
|   "tasks": { |   "tasks": { | ||||||
|     "deploy": [ |     "deploy": [ | ||||||
|       {"command": "cd unleash-server && npm install && npm test && npm run build"}, |       {"command": "npm install && npm test && npm run build"}, | ||||||
|       {"command": "cd unleash-server && tar -cvzf unleash-server.tar.gz --exclude=unleash-server.tar.gz --exclude=.git *"}, |       {"command": "tar -cvzf unleash-server.tar.gz --exclude=unleash-server.tar.gz --exclude=.git *"}, | ||||||
|       { |       { | ||||||
|         "command": "cd unleash-server && mvn deploy:deploy-file -Durl=http://mavenproxy.finntech.no/finntech-internal-snapshot/ -DrepositoryId=finntech-internal-snapshot -Dfile=unleash-server.tar.gz -DgroupId=no.finntech.unleash -DartifactId=unleash-server -Dversion=0.1337-SNAPSHOT -Dpackaging=tar.gz", |         "command": "mvn deploy:deploy-file -Durl=http://mavenproxy.finntech.no/finntech-internal-snapshot/ -DrepositoryId=finntech-internal-snapshot -Dfile=unleash-server.tar.gz -DgroupId=no.finntech.unleash -DartifactId=unleash-server -Dversion=0.1337-SNAPSHOT -Dpackaging=tar.gz", | ||||||
|         "pipelines": [ |         "pipelines": [ | ||||||
|           { |           { | ||||||
|             "name": "unleash-server", |             "name": "unleash-server", | ||||||
| @ -21,9 +21,9 @@ | |||||||
|           } |           } | ||||||
|         ] |         ] | ||||||
|       }, |       }, | ||||||
|       { "command" : "rm unleash-server/sql -Rf && mkdir unleash-server/sql"  }, |       { "command" : "rm -rf sql && mkdir sql"  }, | ||||||
|       { "command" : "cd unleash-server && scripts/generate-liquibase-artifact.js > sql/db.changelog-master.xml"}, |       { "command" : "scripts/generate-liquibase-artifact.js > sql/db.changelog-master.xml"}, | ||||||
|       { "command" : "cd unleash-server && jar -cf ../unleash-db.jar sql"}, |       { "command" : "jar -cf unleash-db.jar sql"}, | ||||||
|       { |       { | ||||||
|         "command": "mvn deploy:deploy-file -Durl=http://mavenproxy.finntech.no/finntech-internal-snapshot/ -DrepositoryId=finntech-internal-snapshot -Dfile=unleash-db.jar -DgroupId=no.finntech.unleash -DartifactId=unleash-db -Dversion=0.1337-SNAPSHOT -Dpackaging=jar", |         "command": "mvn deploy:deploy-file -Durl=http://mavenproxy.finntech.no/finntech-internal-snapshot/ -DrepositoryId=finntech-internal-snapshot -Dfile=unleash-db.jar -DgroupId=no.finntech.unleash -DartifactId=unleash-db -Dversion=0.1337-SNAPSHOT -Dpackaging=jar", | ||||||
|         "pipelines": [ |         "pipelines": [ | ||||||
| @ -36,7 +36,7 @@ | |||||||
| 
 | 
 | ||||||
|     ], |     ], | ||||||
|     "default": [ |     "default": [ | ||||||
|       {"command": "cd unleash-server && npm install && npm test"}, |       {"command": "npm install && npm test"}, | ||||||
| 
 | 
 | ||||||
|     ] |     ] | ||||||
|   } |   } | ||||||
|  | |||||||
| @ -1,48 +0,0 @@ | |||||||
| # unleash-server [](https://travis-ci.org/finn-no/unleash) [](https://codeclimate.com/github/finn-no/unleash) [](https://coveralls.io/r/finn-no/unleash?branch=master) |  | ||||||
| unleash-server is a place to ask for the status of features. |  | ||||||
| 
 |  | ||||||
| ### Create a local unleash-db on postgres |  | ||||||
| 
 |  | ||||||
| ```bash |  | ||||||
| $ 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 |  | ||||||
| 
 |  | ||||||
| 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) |  | ||||||
| 
 |  | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user