Skip to content
Platform API for COMRADES project
PHP Gherkin Other
Branch: master
Clone or download
Shadrock Roberts
Shadrock Roberts Update README.md
Added link to Ushahidi installation instructions.
Latest commit 169cde4 Jun 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Jul 6, 2018
.librarian/puppet Clean up puppet config Jun 18, 2015
.phpspec Change phpspec template to fit with current code Aug 22, 2014
Associated_Files Delete folderstart Feb 27, 2019
app Merge branch 'production-aws' of github.com:ushahidi/platform into co… Oct 26, 2018
bin fix(release): Fix release bundling process for lumen Oct 1, 2018
bootstrap Adding expiration support middleware to prevent post/update/delete op… Aug 10, 2018
config feat: Set release in sentry Sep 19, 2018
database Add laravel boilerplate May 11, 2017
docker fix(release): Fix release bundling process for lumen Oct 1, 2018
docs Fix url to comrades repo Dec 21, 2018
httpdocs refactor: Remove public/ and symlink to httpdocs May 2, 2018
migrations Merge develop with export jobs and twitter fixes to comrades Oct 25, 2018
resources Merge branch 'develop' into 42-duplicated-descriptions Sep 5, 2018
routes Merge branch 'master' of github.com:ushahidi/platform into comrades-v… Oct 24, 2018
seeds feat: Replace built in migrate and seed commands with phinx May 2, 2018
src Fix verifier for signature Oct 26, 2018
storage Begin adding laravel/passport + lumen-passport May 11, 2017
tests test: Stop logging all responses during testing Oct 26, 2018
.arcconfig T1099 - Backend Mar 8, 2015
.arclint Add migrations phpcs ruleset and fix lint errors Sep 8, 2014
.coveralls.yml Add coveralls for phpunit, and behat tests Feb 8, 2016
.dockerignore push docker images to ECR Mar 12, 2018
.editorconfig style: Reformat *everything* to use spaces not tabs May 10, 2018
.env.deploy feat: Set release in sentry Sep 19, 2018
.env.example Adds CORs headers to responses that fail before config is loaded; ref… Jul 30, 2018
.env.testing Adds CORs headers to responses that fail before config is loaded; ref… Jul 30, 2018
.env.travis Merge branch 'develop' into lumen Feb 2, 2018
.gitbook.yaml Revert "Revert "docs(gitbook): add gitbook configuration"" Oct 26, 2018
.gitignore Adding ckan client api, it was not lumen compatible so I added a smal… May 9, 2018
.travis.yml Merge branch 'develop' into build-codeclimate-coverage Sep 18, 2018
CONTRIBUTING.md Updating to define basic info for logging an issue Mar 16, 2016
Dockerfile ci: Fix Dockerfile and associated scripts Apr 26, 2018
Homestead.yaml chore: Change development domain to api.ushahidi.test Dec 14, 2017
LICENSE-AGPL Add list of non agpl licenses code Oct 27, 2013
LICENSE.md Update LICESNE, refs T985 Nov 18, 2014
PULL_REQUEST_TEMPLATE.md Adding I ran my checklist Nov 21, 2017
Procfile Revert "Add incoming / outgoing processes to Procfile" Aug 7, 2015
README.md Update README.md Jun 30, 2019
Vagrantfile Merging Develop into Master (#1730) May 3, 2017
apache_heroku.conf Setup heroku deploy Jan 27, 2015
apiary.apib Move blueprints into docs/api and split into multiple files Jul 28, 2016
app.json Add scheduler add-on to heroku app.json Nov 1, 2016
artisan Fix path to files for media tests May 11, 2017
behat.yml.dist revert change May 1, 2018
captainhook.json build: Fix captainhook check so it doesn't fail on merge commits Apr 20, 2018
codeship-services.yml fix(docker): update image base versions and other container runtime s… Sep 25, 2018
codeship-steps.yml Merge pull request #2801 from ushahidi/ci-flexible-cat-logs Apr 23, 2018
composer.json build: Remove mcrypt dependency Sep 25, 2018
composer.lock build: Remove mcrypt dependency Sep 25, 2018
deployment.env.encrypted 2561 SMS Incoming (#2694) Apr 5, 2018
docker-compose.yml update Dockerfile to use latest version of base image Dec 7, 2017
example.env Use phpdotenv to set DB params Jan 27, 2015
mapping.json Fixed field type Aug 23, 2018
phinx.php style: Reformat *everything* to use spaces not tabs May 10, 2018
phpspec.yml.coverage Run tests on codeship (#1293) Jul 13, 2016
phpspec.yml.dist Merging Develop into Master (#1730) May 3, 2017
phpunit.xml.dist Replacing Ushahidi_Mailer with a Lumen implementation Jul 4, 2017
pre-commit fix: Update TOS tests to new method of setting tokens Dec 1, 2017
public refactor: Remove public/ and symlink to httpdocs May 2, 2018
skeleton.php Switch to a single root namespace for all of Ushahidi, refs T846 Nov 3, 2014

README.md

COMRADES Logo

The COMRADES Platform

This repository holds the code for the COMRADES platform: an open‐source, community resilience platform, to help communities reconnect, respond to, and recover from crisis situations. The project website for this COMRADES H2020 European Project can be found here. It contains a variety of outputs from the project such as specific documentation within reports, access to our training data and ontologies, and academic research. A deployment of the COMRADES platform, which is run of the code in this respository, can be seen at: https://comrades.ushahidi.com.

COMRADES is built on the Ushahidi platform. To use this code, follow the instructions for installing Ushahidi, then see our COMRADES manual below for instructions on configuring all of the necessary services.

What is Ushahidi?

Ushahidi is an open source web application for information collection, visualization and interactive mapping. It helps you to collect info from: SMS, Twitter, RSS feeds, E-mail. It helps you to process that information, categorize it, geo-locate it and publish it on a map. For more information see the Ushahidi website.

Configuration Manual

The Configuration & Set-up Manual for the COMRADES Platform can be found here.

List of Comrades repositories and how they fit together

Description of the system

The code for the Ushahidi Platform is open source. The Comrades Platform uses a specific edition of the platform, containing advanced features to display results from the services integrated in the comrades-service-proxy and send data to other platforms.

Applications

This repository is the for the backend application, which implements the server side of the Comrades system. The backend application runs in a server. Setup instructions can be found in its own repository.

Repository: https://github.com/ushahidi/platform-comrades

Web client application

The web client is the component that end users interact with when opening the system website with a web browser. The web client interacts with the backend in order to perform operations on the system (i.e. submit posts, query posts). The web client runs in the users’ browsers. Setup instructions can be found in its own repository.

Repository: https://github.com/ushahidi/platform-client-comrades

Comrades Service Proxy

The service proxy interacts with the backend application (platform-comrades) to process the content of posts submitted by users. It fetches information from external services such as YODIE, CREES and EMINA where content from the platform is processed to be augmented with extra information or categorized depending on the service called, and then sends that information back to the platform-comrades service. The service proxy runs in a server, it can be run either in the same server or a different one. The platform URL and other configuration settings can be changed through an .ENV file in the service proxy. Setup instructions can be found in its own repository

Repository: https://github.com/ushahidi/comrades-service-proxy

Facebook Bot

The Facebook bot is used for communicating with users through facebook-messenger. Users can create reporrts by chatting with the bot and they are then sent back to the platform, wheere they can be processed by the service proxy if the user configures the webhooks for it. The Facebook bot runs in a server, it can be run either in the same server or a different one. The platform URL and other configuration settings can be changed through an .ENV file in the repository. Setup instructions can be found in its own repository

Repository: https://github.com/ushahidi/platform-facebook-bot

Acknowledgment

This work has received support from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 687847.

Getting Involved

The code for COMRADES is open source under the AGPL license in this repository. We welcome contributions to our code! Ushahdi maintains a variety of communications channels to help contributors. Please see our support page on the Ushhaidi website for more details on how to contribute.

You can’t perform that action at this time.