Skip to content

ushahidi/platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Wisdom EbongMh-Asmi
Wisdom Ebong
and
Jan 22, 2025
4d133a5 · Jan 22, 2025
Aug 3, 2022
Jun 5, 2024
Jun 18, 2015
Aug 22, 2014
Mar 4, 2020
Jan 10, 2024
Nov 1, 2023
Oct 7, 2024
Nov 6, 2024
Feb 27, 2024
Mar 18, 2024
Jan 6, 2021
May 3, 2022
Oct 29, 2024
Aug 3, 2022
Jan 22, 2025
Oct 25, 2018
Jan 21, 2025
Dec 2, 2020
Mar 8, 2015
Sep 8, 2014
Feb 8, 2016
Sep 13, 2022
May 10, 2018
Jul 1, 2022
Sep 13, 2022
Jul 10, 2023
Nov 14, 2022
Mar 6, 2020
Oct 18, 2018
Dec 14, 2023
Mar 6, 2020
Oct 10, 2020
Oct 7, 2024
Apr 26, 2023
Oct 27, 2013
May 6, 2022
Dec 14, 2023
Nov 21, 2017
Aug 7, 2015
Dec 14, 2023
Aug 19, 2019
Aug 3, 2022
Jan 27, 2015
Jul 28, 2016
May 30, 2019
Jun 21, 2022
Mar 10, 2023
Aug 26, 2022
Mar 18, 2024
Aug 26, 2022
Sep 9, 2024
Sep 9, 2024
Oct 13, 2020
Nov 21, 2024
Dec 14, 2023
Dec 14, 2023
Jan 27, 2015
Sep 13, 2022
Aug 23, 2018
Jul 6, 2021
Nov 21, 2024
Jul 13, 2016
Apr 26, 2017
Mar 1, 2023
Dec 1, 2017
May 2, 2018
Apr 25, 2022
Nov 3, 2014

Repository files navigation

Ushahidi Platform

What is Ushahidi Platform?

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

This repository contains the backend code with the REST API implementation.

Head over to the Platform Client repository for the browser app code.

Setup essentials

The shortest path to get up and running is:

  • Install Docker Engine
  • Install Make command (parses Makefile)
  • Run make start

The backend will be listening on localhost:8080.

What about the browser client application?

Once your Platform backend is running, head over to the platform-client-mzima repository to get the in-browser Platform experience!

Other helpful commands

You may use make start to restart the containers (does a full container build).

You may use make apply to apply dependency and migration changes to containers (without full container build). Note: this requires containers to be up. ​ To stop Docker containers run make stop

To take everything down (including deleting the database) make down will do that for you.

WIP: to run the automated tests ...

Manuals and documentation

A note for grassroots organizations

If you are starting a deployment for a grassroots organization, you can apply for a free social-impact responder account here after verifying that you meet the criteria.

Platform User Manual

The official reference on how to use the Platform. Create surveys, configure data sources... it's all in there! Platform User Manual

Platform Developer Documentation

Key pointers on installing and developing on the Platform.

Platform Developer Documentation

Credits

Contributors ✨

Thanks goes to the wonderful people who [Contribute]! See the list of contributors at all-contributors This project follows the all-contributors specification. Contributions of any kind welcome!

Useful Links