From c764a16521e637df6abc222ff23faa36528d7f15 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 11 Aug 2022 16:02:41 +0200 Subject: [PATCH 01/14] test for changes by normaW and leonH test for changes by normaW and leonH_01 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ad16702d..dd04414b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Zendro logo](figures/Zendro_logo_horizontal.png) - +this is a short test # Zendro Zendro is a software tool to quickly create a data warehouse tailored to your specifications. You tell Zendro what the structure of your data is, in the form of models, and where the data is or shall be stored. Zendro will then automatically create two standardized interfaces for your data models. Both interfaces provide access to the standard CRUD, create, read, update, and delete functions, available for each of the defined data models. One of the two interfaces is an intuitive graphical browser based single page application implemented in Google's standard material design. The other is an exhaustive application programming interface built with Facebook's efficient GraphQL framework, enabling a connection to your data warehouse from any programming language or data analysis pipeline with utmost ease, simply by sending HTTP requests to your GraphQL server. Data can be distributed over several databases and servers without losing the relationships between your data records, even if they are not stored in the same place. From d737d358fe2e33e4e63e9e4615628f84e188de35 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 11 Aug 2022 16:06:20 +0200 Subject: [PATCH 02/14] undone test text deleted --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dd04414b..ad16702d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Zendro logo](figures/Zendro_logo_horizontal.png) -this is a short test + # Zendro Zendro is a software tool to quickly create a data warehouse tailored to your specifications. You tell Zendro what the structure of your data is, in the form of models, and where the data is or shall be stored. Zendro will then automatically create two standardized interfaces for your data models. Both interfaces provide access to the standard CRUD, create, read, update, and delete functions, available for each of the defined data models. One of the two interfaces is an intuitive graphical browser based single page application implemented in Google's standard material design. The other is an exhaustive application programming interface built with Facebook's efficient GraphQL framework, enabling a connection to your data warehouse from any programming language or data analysis pipeline with utmost ease, simply by sending HTTP requests to your GraphQL server. Data can be distributed over several databases and servers without losing the relationships between your data records, even if they are not stored in the same place. From 090a9dddba17071d81fef93386bc5580d895fc77 Mon Sep 17 00:00:00 2001 From: NormaW <71231261+NormaW@users.noreply.github.com> Date: Thu, 11 Aug 2022 17:15:36 +0200 Subject: [PATCH 03/14] npm link i had to add sudo ('sudo npm link') that it works --- quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.md b/quickstart.md index 479ea534..c6fc669c 100644 --- a/quickstart.md +++ b/quickstart.md @@ -23,7 +23,7 @@ Execute this commands to install Zendro: $ git clone https://github.com/Zendro-dev/zendro.git $ cd zendro $ npm install -$ npm link +$ npm link #sudo npm link? ``` ### Step 2: Setup a new Zendro project From f015a66744ecee7c1bef905148d0c49eb071bf57 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Wed, 17 Aug 2022 11:41:51 +0200 Subject: [PATCH 04/14] added "Yarn" as requirement --- setup_root.md | 1 + 1 file changed, 1 insertion(+) diff --git a/setup_root.md b/setup_root.md index caea9d9d..5600ba4b 100644 --- a/setup_root.md +++ b/setup_root.md @@ -10,6 +10,7 @@ Zendro consists of four source-code projects: __graphql-server-model-codegen__, ## Project Requirements: * [NodeJS](https://nodejs.org/en/) version 14+ is required. + * [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) **recommended for setting up zendro using docker** * [docker](https://docs.docker.com/get-docker/) From 92861154054e5dc2fe9b237f5b92dc84b514aa72 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Wed, 17 Aug 2022 11:44:15 +0200 Subject: [PATCH 05/14] added "in your project directory" at editing env vars --- setup_root.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup_root.md b/setup_root.md index 5600ba4b..ecbf3f42 100644 --- a/setup_root.md +++ b/setup_root.md @@ -42,7 +42,7 @@ $ zendro new -d -### Step 3: Edit environment variables +### Step 3: Edit environment variables in your project directory Go inside the new project and modify the selected enviroment variables in the next files. These files have a default configuration, please remember to add your expected secret word in the *NEXTAUTH_SECRET* variable. From 4de1b1b6209324850cb7e161a5253e121325cd86 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Wed, 17 Aug 2022 15:50:20 +0200 Subject: [PATCH 06/14] Update setup_root.md --- setup_root.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup_root.md b/setup_root.md index ecbf3f42..bfc4b89e 100644 --- a/setup_root.md +++ b/setup_root.md @@ -46,8 +46,8 @@ $ zendro new -d Go inside the new project and modify the selected enviroment variables in the next files. These files have a default configuration, please remember to add your expected secret word in the *NEXTAUTH_SECRET* variable. -* **Without docker setup:** ./graphql-server/config/data_models_storage_config.json -* **With docker setup:** ./config/data_models_storage_config.json +* **Without docker setup:** ./graphql-server/config/data_models_storage_config.json (specify data model here) +* **With docker setup:** ./config/data_models_storage_config.json (specify data model here) * **SPA in development mode:** ./single-page-app/.env.development * **SPA in production mode:** ./single-page-app/.env.production * **GraphiQL in development mode:** ./graphiql-auth/.env.development From ec116a61656d5267af38fb9d737d4fd13f325d5d Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Wed, 17 Aug 2022 15:52:06 +0200 Subject: [PATCH 07/14] Update setup_root.md --- setup_root.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup_root.md b/setup_root.md index bfc4b89e..15e31595 100644 --- a/setup_root.md +++ b/setup_root.md @@ -44,7 +44,7 @@ $ zendro new -d ### Step 3: Edit environment variables in your project directory -Go inside the new project and modify the selected enviroment variables in the next files. These files have a default configuration, please remember to add your expected secret word in the *NEXTAUTH_SECRET* variable. +Go inside the new project and modify the selected enviroment variables in the next files. These files have a default configuration, please remember to add your expected secret word in the preexisting *NEXTAUTH_SECRET* variable. * **Without docker setup:** ./graphql-server/config/data_models_storage_config.json (specify data model here) * **With docker setup:** ./config/data_models_storage_config.json (specify data model here) From 820e046ff0af7652969990713addfe904c5a6e1b Mon Sep 17 00:00:00 2001 From: NormaW <71231261+NormaW@users.noreply.github.com> Date: Tue, 23 Aug 2022 14:46:18 +0200 Subject: [PATCH 08/14] check logs using the container ID worked and the container name did not work --- quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.md b/quickstart.md index c6fc669c..75347e71 100644 --- a/quickstart.md +++ b/quickstart.md @@ -88,7 +88,7 @@ $ docker ps You can check docker logs by: ``` -$ docker logs -f +$ docker logs -f #for us the container id worked, the name did not ``` > ***Please wait until logs indicate the app is running on XXXX port to access Zendro services.*** From ba3b2378f4298f4491217aea2bc57068cce7e742 Mon Sep 17 00:00:00 2001 From: NormaW <71231261+NormaW@users.noreply.github.com> Date: Thu, 8 Sep 2022 08:11:42 +0200 Subject: [PATCH 09/14] Keycloak link with /auth line 123 Keycloak: line 124 http://localhost:8081/auth without /auth the link does not work, in our cases --- setup_root.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup_root.md b/setup_root.md index fcff0c9b..fcbe6a26 100644 --- a/setup_root.md +++ b/setup_root.md @@ -121,7 +121,7 @@ $ docker logs -f In default config, the running containers will be: * Keycloak: - * http://localhost:8081 + * http://localhost:8081/auth * The default keycloak username is *admin* and the password is *admin*. From 6685f8162f02ce9cd5f66a869a7bb6087a01c4b5 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 8 Sep 2022 08:44:42 +0200 Subject: [PATCH 10/14] Update README.md added empty link for "How to uppload data using the SPA" --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ad16702d..7a5e2b6c 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ If you have any questions or comments, please don't hesitate to contact us via a ### HOW-TO GUIDES: * [How to define data models: for developers](setup_data_scheme.md). Detailed technical specifications on how to define data models for Zendro, aimed at software developers and system administrators. * [How to define data models: for non-developers](non-developer_documentation.md). A brief, illustrated guide of data model specifications, data formatting and data uploading options, aimed at data modelers or managers to facilitate collaboration with developers. +* [How to upload data using the SPA]. A tutorial of the SPA data-upload function. * [How to use Zendro command line interface (CLI)](zendro_cli.md). A tutorial of Zendro CLI, aimed at software developers. * [How to query and extract data](fromGraphQlToR.html). A concise guide on how to use the Zendro API from R to extract data and perform queries, aimed at data managers or data scientists. * [How to setup Authentication / Authorization](oauth.md). A concise guide on how to use and setup the Zendro authorization / authentication services. From f54f5623004ebc2f2586ec9f48b11eb550b28b06 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 8 Sep 2022 08:45:12 +0200 Subject: [PATCH 11/14] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a5e2b6c..74faafd9 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ If you have any questions or comments, please don't hesitate to contact us via a ### HOW-TO GUIDES: * [How to define data models: for developers](setup_data_scheme.md). Detailed technical specifications on how to define data models for Zendro, aimed at software developers and system administrators. * [How to define data models: for non-developers](non-developer_documentation.md). A brief, illustrated guide of data model specifications, data formatting and data uploading options, aimed at data modelers or managers to facilitate collaboration with developers. -* [How to upload data using the SPA]. A tutorial of the SPA data-upload function. +* [How to add data using the SPA]. A tutorial of the SPA data-upload function. * [How to use Zendro command line interface (CLI)](zendro_cli.md). A tutorial of Zendro CLI, aimed at software developers. * [How to query and extract data](fromGraphQlToR.html). A concise guide on how to use the Zendro API from R to extract data and perform queries, aimed at data managers or data scientists. * [How to setup Authentication / Authorization](oauth.md). A concise guide on how to use and setup the Zendro authorization / authentication services. From 7aba1a8676228b3494379fd7c21f71f9bc19d59e Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 8 Sep 2022 08:52:31 +0200 Subject: [PATCH 12/14] Update quickstart.md --- quickstart.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/quickstart.md b/quickstart.md index 12e1f6c1..d255efd5 100644 --- a/quickstart.md +++ b/quickstart.md @@ -55,7 +55,7 @@ If you want to know more about the enviroment variables, you can check [this](en #### Development mode -To start Zendro in development mode run +To start Zendro in development mode, run the following command from within your project directory: ``` $ zendro dockerize -u @@ -68,7 +68,7 @@ In development mode there is no reverse proxy to map the docker-services. Instea **Note**: We recommend to use Linux system for development mode. #### Production mode -Execute this command to start Zendro in production mode. +Execute this command from within your project directory to start Zendro in production mode: ``` $ zendro dockerize -u -p From 818d038e501bc3709472f2892bfbb576d9412db2 Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 8 Sep 2022 08:53:46 +0200 Subject: [PATCH 13/14] Update setup_root.md --- setup_root.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup_root.md b/setup_root.md index fcbe6a26..7b8a124d 100644 --- a/setup_root.md +++ b/setup_root.md @@ -93,7 +93,7 @@ In this file you can define any number of database connections, that zendro shou The recommend way to [run your Zendro instance is via docker](https://zendro-dev.github.io/zendro_cli.html#dockerize-zendro-app-with-example-docker-files). This ensures that regardless of your local infrastructure Zendro will behave the same. -Execute this command to start Zendro in production mode or without `-p` to start in development mode. +Execute this command to start Zendro in production mode or without `-p` to start in development mode, each from within your project directory. ``` $ zendro dockerize -u -p From b3be10dd7d7962be7f0925d435db96abd628655f Mon Sep 17 00:00:00 2001 From: Leon <50839616+leonhummernbrum@users.noreply.github.com> Date: Thu, 8 Sep 2022 08:59:50 +0200 Subject: [PATCH 14/14] Update quickstart.md added yarn as required software --- quickstart.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/quickstart.md b/quickstart.md index d255efd5..7ba603c5 100644 --- a/quickstart.md +++ b/quickstart.md @@ -10,6 +10,9 @@ If you want to know more about Zendro or a detailed explanation on how to set up ## Project Requirements: * [NodeJS](https://nodejs.org/en/) version 14+ is required. + * [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) + + **recommended for setting up zendro using docker** * [docker](https://docs.docker.com/get-docker/) * [docker-compose](https://docs.docker.com/compose/install/#install-compose)