Platform Developer Documentation
Search…
👋
Welcome | README
Code of Conduct
Contributing | Getting Involved
Frequently Asked Questions
Join the Ushahidi community
Contributors ✨
🛣️ The Ushahidi Platform Roadmap
Privacy and security best practices
Development & Code
Development: Overview
How to get the source code
Setup Guides
Installing for production environments
Development environment with XAMPP
Development environment setup with Vagrant
[Client] Setting up the Platform Client for development
Setting up the Pattern Library for development
[API & Client] Bundled release install
Add code to Ushahidi
Development process
Coding Standards
Track and submit issues in Github
Upgrading Ushahidi
⚙️ Installation Helper
Tech Stack
API Documentation
Third party app development
Database | Tables overview
Database | Database Schema Diagram
Database | Table details
📐
Architecture
Use case internals
QA & Testing
The QA process
How to run QA tests
Defect Management
How to write QA test scripts
Hotfixes
Front-end development
Changing UI styles: introduction to the pattern library
Design
🎨
Design: overview
'Best practice' design
Ushahidi Platform 'Sticker Sheet'
User testing process
User testing script examples
Synthesising user testing results examples
Open Source Design
Documentation
Documentation
Contributing docs via GitHub
Translation
Localization and Translation
The Ushahidi Platform Facebook bot
The Facebook bot
Hackathon and events
Installathon, May 2019
Write/Speak/Code 2019
Open Design: Bangalore
Open Design: Taipei
📑
Google season of docs
Enhancement Proposals
Exchange Format
Importing data from previous versions
Powered By
GitBook
Setup Guides
Deploying to production environments
Deploy-ready versions from the platform-release repository, which contains production-ready tags of the platform. Ready to use with docker.
Installing for production environments
Platform API (Backend) Install Guides
Installing with Vagrant
This is the preferred option for local development. The Ushahidi dev team uses this setup for most of their development work.
Development environment setup with Vagrant
Installing with XAMPP
This option is only recommended for local development, in particular for situations where it's not feasible or desirable to setup vagrant or docker. It has been tested and developed with the help of members of our community.
Development environment with XAMPP
Installing from the platform-release repository
Deploy-ready versions from the platform-release repository, which contains production-ready tags of the platform. Ready to use with docker.
[API & Client] Bundled release install
Platform Client (Frontend) install guides
[Client] Setting up the Platform Client for development
Platform Pattern Library (HTML/CSS) install guide
If you plan to change the css for the Platform Client, follow this guide.
Setting up the Pattern Library for development
Development & Code - Previous
How to get the source code
Next
Installing for production environments
Last modified
2yr ago
Copy link
Contents
Deploying to production environments
Platform API (Backend) Install Guides
Installing with Vagrant
Installing with XAMPP
Installing from the platform-release repository
Platform Client (Frontend) install guides
Platform Pattern Library (HTML/CSS) install guide