Update docs

This commit is contained in:
Disassembler 2021-01-24 12:14:59 +01:00
parent 521f3f2ab6
commit 89c4e2e88f
No known key found for this signature in database
GPG Key ID: 524BD33A0EE29499
4 changed files with 63 additions and 20 deletions

View File

@ -12,10 +12,26 @@ API URL: https://github.com/taarifa/TaarifaAPI
Fork URL: https://github.com/trendspotter/TaarifaWaterpoints - the fork contains fixes for python3 compatibility and ready-to-use release package with frontent build using the method below.
MongoDB
-------
Application uses MongoDB NoSQL database as a data storage, currently running as unsecured instance without any admin user.
Data need to be prepopulated before the application can be used for the first time. Prepopulation is done as part of installation script as follows
.. code-block:: bash
cd /srv/taarifa
export MONGO_URI=mongodb://taarifa-mongodb/taarifa
python manage.py create_facility
python manage.py create_service
python manage.py upload_waterpoints demodata.csv
Frontend build
--------------
Frontend requires ancient verions of packages to work correctly. Followin sequence produces usable dist directory on Debian 10.
Frontend requires ancient verions of packages to work correctly. Following sequence produces usable dist directory on Debian 10.
.. code-block:: bash

View File

@ -80,7 +80,7 @@ Java
- **General description:** Java runtime environment
- **Tech. description:** Java OpenJDK 8 runtime environment
- **Depends on:** -
- **Used by:** ActiveMQ, FrontlineSMS, Tomcat, CrisisCleanup, MifosX, Motech, OpenDataKit, OpenMapKit, Sigmah, Solr
- **Used by:** ActiveMQ, DHIS2, FrontlineSMS, Tomcat, CrisisCleanup, MifosX, Motech, OpenDataKit, OpenMapKit, Sigmah, Solr
- **Related skills:** -
Nodejs
@ -107,7 +107,7 @@ Python 2
- **General description:** Python 2 runtime environment
- **Tech. description:** Python 2 runtime environment and standard libraries
- **Depends on:** -
- **Used by:** CKAN, CKAN DataPusher, CTS, OpenMapKit, Sahana Eden
- **Used by:** CTS, OpenMapKit
- **Related skills:** linux compilation toolchain (header files, gcc, make etc.), pip, python (language overview)
Python 3
@ -116,7 +116,7 @@ Python 3
- **General description:** Python 3 runtime environment
- **Tech. description:** Python 3 runtime environment and standard libraries
- **Depends on:** -
- **Used by:** GNU Health, Odoo, Pan.do/ra, SeedDMS, VMMgr (doesn't use container)
- **Used by:** CKAN, CKAN DataPusher, GNU Health, Odoo, Pan.do/ra, Sahana Eden, SeedDMS, Taarifa Waterpoints, VMMgr (doesn't use container)
- **Related skills:** linux compilation toolchain (header files, gcc, make etc.), pip, python (language overview)
Ruby
@ -125,7 +125,7 @@ Ruby
- **General description:** Ruby runtime environment
- **Tech. description:** Ruby 2.4 runtime environment and gem package installer
- **Depends on:** -
- **Used by:** CrisisCleanup, OpenDataKit Build
- **Used by:** CrisisCleanup, Decidim, OpenDataKit Build
- **Related skills:** linux compilation toolchain (header files, gcc, make etc.)
Tomcat
@ -160,13 +160,22 @@ MariaDB
- **Used by:** MifosX, Ushahidi
- **Related skills:** SQL (language overview)
MongoDB
^^^^^^^
- **General description:** NoSQL database server
- **Tech. description:** NoSQL JSON/BSON document-based database management system
- **Depends on:** -
- **Used by:** Taarifa Waterpoints
- **Related skills:** JSON
Postgres
^^^^^^^^
- **General description:** PostgreSQL database server
- **Tech. description:** PostgreSQL relational database management system
- **Depends on:** -
- **Used by:** CKAN, CrisisCleanup, CTS, GNU Health, Kanboard, Motech, Odoo, OpenDataKit, OpenDataKit Build, OpenMapKit, Pan.do/ra, Sahana Eden, SeedDMS, Sigmah
- **Used by:** CKAN, CrisisCleanup, CTS, Decidim, DHIS2, GNU Health, Kanboard, Motech, Odoo, OpenDataKit, OpenDataKit Build, OpenMapKit, Pan.do/ra, Sahana Eden, SeedDMS, Sigmah
- **Related skills:** SQL (language overview)
RabbitMQ
@ -247,6 +256,15 @@ Decidim
- **Used by:** User
- **Related skills:** Nodejs build systems (npm, yarn), Ruby build systems and frameworks (Bundle, Devise, Gems, Rails, Rake)
DHIS2
^^^^^
- **General description:** Platform for collecting, managing, analyzing, visualizing and sharing medical data
- **Tech. description:** Spring-based RESTful API backend with Nodejs-packed frontend
- **Depends on:** Java, Nodejs, Postgres
- **Used by:** User
- **Related skills:** Nodejs build systems (npm), Java build systems and frameworks (Maven, Apache Struts, Spring)
FrontlineSMS
^^^^^^^^^^^^
@ -277,7 +295,7 @@ Kanboard
MifosX
^^^^^^
- **General description:**
- **General description:** Microfinancing for development projects
- **Tech. description:** Spring-based forms application RPC backend with Nodejs-packed frontend
- **Depends on:** MariaDB, Tomcat
- **Used by:** User
@ -286,7 +304,7 @@ MifosX
Motech
^^^^^^
- **General description:**
- **General description:** Communication automation (Emails, SMS etc.)
- **Tech. description:** Apache Felix-based forms application
- **Depends on:** ActiveMQ, Postgres, Tomcat
- **Used by:** User
@ -295,7 +313,7 @@ Motech
Odoo
^^^^
- **General description:**
- **General description:** Company management application suite
- **Tech. description:** Werkzeug-based forms application RPC backend with Nodejs-based frontend
- **Depends on:** Nodejs, Postgres, Python 3
- **Used by:** User
@ -304,7 +322,7 @@ Odoo
OpenDataKit
^^^^^^^^^^^
- **General description:**
- **General description:** Form data collection server
- **Tech. description:** Spring and OpenRosa-based data store application
- **Depends on:** Postgres, Tomcat
- **Used by:** User
@ -313,7 +331,7 @@ OpenDataKit
OpenDataKit Build
^^^^^^^^^^^^^^^^^
- **General description:**
- **General description:** Form data collection designer
- **Tech. description:** Ruby-based forms application with Nodejs-based data converter
- **Depends on:** Nodejs, Ruby
- **Used by:** User
@ -322,7 +340,7 @@ OpenDataKit Build
OpenMapKit
^^^^^^^^^^
- **General description:**
- **General description:** Map data collection server
- **Tech. description:** Nodejs-based forms application with python dependencies
- **Depends on:** Nodejs, Postgres, Python 2
- **Used by:** User
@ -331,7 +349,7 @@ OpenMapKit
Pan.do/ra
^^^^^^^^^
- **General description:**
- **General description:** Multimedia library and archive
- **Tech. description:** Python-based media store with Javascript-based frontend
- **Depends on:** Postgres, Python 3, RabbitMQ
- **Used by:** User
@ -340,16 +358,16 @@ Pan.do/ra
Sahana Eden
^^^^^^^^^^^
- **General description:**
- **General description:** Management of humanitarian activities
- **Tech. description:** Web2py-based forms application
- **Depends on:** Postgres, Python 2
- **Depends on:** Postgres, Python 3
- **Used by:** User
- **Related skills:** PostGIS, python frameworks and modules (requests, selenium, Web2py)
SeedDMS
^^^^^^^
- **General description:**
- **General description:** Document management system
- **Tech. description:** PHP-based data store application with Lucene-based fulltext index
- **Depends on:** PHP, Postgres
- **Used by:** User
@ -358,12 +376,21 @@ SeedDMS
Sigmah
^^^^^^^
- **General description:**
- **General description:** Donation management
- **Tech. description:** Apache Commons-based forms application
- **Depends on:** Postgres, Tomcat
- **Used by:** User
- **Related skills:** Java development (hibernate, log4j)
Taarifa Waterpoints
^^^^^^^^^^^^^^^^^^^
- **General description:** Waterpoint management system
- **Tech. description:** Python RESTful API backend with nodejs-packed frontend
- **Depends on:** MongoDB, Nodejs, Python 3
- **Used by:** User
- **Related skills:** Nodejs build systems (npm, grunt, bower)
Ushahidi
^^^^^^^^

View File

@ -3,7 +3,7 @@
"meta": {
"title": "Mifos X",
"desc-cs": "Mikrofinancování rozvojových projektů",
"desc-en": "Development projects microfinancing",
"desc-en": "Microfinancing for development projects",
"license": "GPL"
},
"containers": {

View File

@ -2,8 +2,8 @@
"version": "0.0.1-210106",
"meta": {
"title": "Pan.do/ra",
"desc-cs": "Archiv medií",
"desc-en": "Media archive",
"desc-cs": "Knihovna a archiv multimédií",
"desc-en": "Multimedia library and archive",
"license": "GPL"
},
"containers": {