Merge pull request #1 from WISCENTD-UPC/develop

First stable version

Author: raquelpanapalen

.env

@@ -0,0 +1,3 @@
+REACT_APP_DHIS2_BASE_URL='http://localhost:8080'
+REACT_APP_DHIS2_APP_NAME='Go.Data-DHIS2 Interoperability app'
+REACT_APP_DHIS2_API_VERSION=32

.gitignore

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+
+.eslintcache
+*.zip

README.md

@@ -1,2 +1,42 @@
-# interoperability-app
+## Go.Data-DHIS2 Interoperability App
 DHIS2 basic app to allow interoperability between DHIS2 and Go.Data instances
+![Architecture summary](./images/overview.png)
+
+## Requirements
+
+- Node.js (>= v12.x) and npm (>= v6.x) installed in the system.
+
+## Installation
+
++ Clone the repository or download it as a zip file.
++ In a terminal, install the dependencies by executing ```npm install``` inside the project folder.
++ In a terminal, run the command ```npm run build``` or ```yarn build``` to build the app for production into the `build` folder.
++ Compress the `build` folder, go to the *App Management* app inside your DHIS2 instance and upload the compressed .zip.
+
+![App Management DHIS2](./images/app-management.png)
+
+## App Functionality
+
++ **Import Credentials**: The first thing that needs to be configured is the connection to both DHIS2 and Go.Data APIs. A base endpoint has to be provided for each service, as well as the credentials needed for the authentication. Once the form is submitted, the information will be saved on the DHIS2 Data Store.
+
+<p align="center">
+    <img src="./images/credentials.png" width="700">
+</p>
+
++ **Base configuration settings**: To adapt the process to a specific DHIS2 structure, configurable parameters settings must be provided. There are also additional parameters related to outbreak creation and configuration. Once the form is submitted, the information will be saved on the DHIS2 Data Store.
+
+<p align="center">
+    <img src="./images/base-config.png" width="600">
+</p>
+
++ **Export data and metadata**: There are two possible export sequences. Both ways are equivalent, the only difference is that the *Full transfer* sequence groups *Copy Metadata*, *Create outbreaks*, *Copy cases* and *Copy contacts* all in one step. 
+    + Copy Organisation Units: At the end of this step, a pop-up window will appear to download the orgUnits `.json`. This file needs to be saved on the computer and imported on the Go.Data instance following the path: <br />
+    `Go.Data → Locations → Quick Actions → Import hierarchical locations → Choose file (organisation-units.json) → Import`    
+
+    ![Screenshot of Go.Data locations](./images/locations-path.png)
+
+    Once this file has been correctly imported, carry on with the next steps. Before moving on to the next step, all the pop-up messages have to be checked as done (✓).
+
+<p align="center">
+    <img src="./images/step-by-step.png" width=600>
+</p>

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

i18n/en.pot

@@ -0,0 +1,15 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: i18next-conv\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1)\n"
+"POT-Creation-Date: 2020-11-26T09:36:46.653Z\n"
+"PO-Revision-Date: 2020-11-26T09:36:46.653Z\n"
+
+msgid "Hello {{name}}"
+msgstr ""
+
+msgid "Welcome to DHIS2!"
+msgstr ""