diff --git a/README.md b/README.md index ad16702d..74faafd9 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 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. diff --git a/quickstart.md b/quickstart.md index 1caa54c8..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)

@@ -23,7 +26,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 @@ -55,7 +58,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 +71,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 @@ -88,7 +91,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.*** diff --git a/setup_root.md b/setup_root.md index 1a22784f..7b8a124d 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/) @@ -41,12 +42,12 @@ $ 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. +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 -* **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 @@ -92,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 @@ -120,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*.