From f195419fc57ea8be89479d86a7870cf8a0d8066c Mon Sep 17 00:00:00 2001 From: thde Date: Mon, 22 May 2017 22:09:18 +0200 Subject: [PATCH 1/7] add setup --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 25ee10a..72efdd2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,55 @@ -# tylr -tylr ist ein System, welches Gruppen die Möglichkeit bietet, gemeinsame Ausgaben untereinander aufzuteilen. \ No newline at end of file +# TYLR +TYLR is a REST API to help you to split up expenses in groups. + +TODO: +* Port +* SQL create user + +## Run from binaries + +Perquisites: + + - Java / OpenJDK 8 + - PostgreSQL 9 + +1. Install the perquisites. +2. Download the newest release form Github. +3. Run the following commands to create a user and database: + +```` +CREATE USER tylr IDENTIFIED BY 'tylr'; +CREATE DATABASE tylr WITH OWNER tylr ENCODING 'UTF8' LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8' +GRANT ALL PRIVILEGES ON DATABASE tylr- to tylr; +```` + +```` +psql -f sql/create_tables.sql tylr tylr +```` + +4. Create the`applications.properties` file and add the database credentials. + +```` +# Datasource settings +spring.datasource.url = jdbc:postgresql://localhost:5432/tylr +spring.datasource.username = tylr +spring.datasource.password = tylr +#server.port = 4567 #default +#server.ip = 127.0.0.1 #default +```` + +5. Run `scripts/tylr-api` to start the TYLR. +6. Access it through http://localhost:PORT + +If you want to access the API from outside localhost or / and SSL, you need to use a reverse proxy in front of the application like an NGINX. + +## Run from source + +Perquisites: + + - Java / OpenJDK 8 + - PostgreSQL 9 + +1. Install the perquisites. +2. Clone the master branch or a version tag from Github. +3. Do steps 4 and 5 from above. +4. Run `./gradlew run` to run TYLR. \ No newline at end of file From 726defdeceb0ff35b6e9f12a1167d89437fef267 Mon Sep 17 00:00:00 2001 From: thde Date: Mon, 22 May 2017 22:09:26 +0200 Subject: [PATCH 2/7] add optional settings --- application.properties-example | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/application.properties-example b/application.properties-example index 9150693..6add423 100644 --- a/application.properties-example +++ b/application.properties-example @@ -1,4 +1,6 @@ # Datasource settings spring.datasource.url = jdbc:postgresql://localhost:5432/tylr spring.datasource.username = tylr -spring.datasource.password = tylr \ No newline at end of file +spring.datasource.password = tylr +#server.port = 4567 #default +#server.ip = 127.0.0.1 #default \ No newline at end of file From e63eb97dd88406510f3c4133fe6a11171f6401f5 Mon Sep 17 00:00:00 2001 From: thde Date: Mon, 22 May 2017 22:11:02 +0200 Subject: [PATCH 3/7] fix usage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 72efdd2..419a858 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ spring.datasource.password = tylr 5. Run `scripts/tylr-api` to start the TYLR. 6. Access it through http://localhost:PORT -If you want to access the API from outside localhost or / and SSL, you need to use a reverse proxy in front of the application like an NGINX. +If you want to access the API from outside localhost or / and SSL, use a reverse proxy in front of the application like an NGINX. ## Run from source From dd08e138093b365dbde037ead9dfae36b532b7c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20R=C3=B6llin?= Date: Tue, 23 May 2017 09:16:04 +0200 Subject: [PATCH 4/7] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 419a858..b60888f 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ TODO: ## Run from binaries -Perquisites: +Prerequisites: - Java / OpenJDK 8 - PostgreSQL 9 -1. Install the perquisites. -2. Download the newest release form Github. +1. Install the prerequisites. +2. Download the newest release fromm Github. 3. Run the following commands to create a user and database: ```` @@ -44,12 +44,12 @@ If you want to access the API from outside localhost or / and SSL, use a reverse ## Run from source -Perquisites: +Prerequisites: - Java / OpenJDK 8 - PostgreSQL 9 -1. Install the perquisites. +1. Install the prerequisites. 2. Clone the master branch or a version tag from Github. 3. Do steps 4 and 5 from above. -4. Run `./gradlew run` to run TYLR. \ No newline at end of file +4. Run `./gradlew run` to run TYLR. From 73837b23d96513169fcc1bcc8d7a7d91242d8a4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20R=C3=B6llin?= Date: Tue, 23 May 2017 09:16:33 +0200 Subject: [PATCH 5/7] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b60888f..3a6f481 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Prerequisites: - PostgreSQL 9 1. Install the prerequisites. -2. Download the newest release fromm Github. +2. Download the newest release from Github. 3. Run the following commands to create a user and database: ```` From be1da3df73f2887f41c35ebc93f2199b559e10b2 Mon Sep 17 00:00:00 2001 From: Demian Date: Tue, 23 May 2017 09:18:03 +0200 Subject: [PATCH 6/7] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a6f481..c4720df 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Prerequisites: ```` CREATE USER tylr IDENTIFIED BY 'tylr'; CREATE DATABASE tylr WITH OWNER tylr ENCODING 'UTF8' LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8' -GRANT ALL PRIVILEGES ON DATABASE tylr- to tylr; +GRANT ALL PRIVILEGES ON DATABASE tylr to tylr; ```` ```` From 354eb7f6d40f202d002725c96ab1ddf53afbb197 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20R=C3=B6llin?= Date: Tue, 23 May 2017 14:06:56 +0200 Subject: [PATCH 7/7] Remove todo --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index c4720df..9cf8ab3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ # TYLR TYLR is a REST API to help you to split up expenses in groups. -TODO: -* Port -* SQL create user - ## Run from binaries Prerequisites: