Setting up the API with Docker

The Ushahidi Platform API is a crucial component of the Ushahidi Platform, allowing users to interact with the system's data and perform various operations. This guide will walk you through the process of setting up the Ushahidi Platform API using Docker, a popular containerization platform that simplifies application deployment and management.

To get up and running, follow these steps:

1. Clone the code (if you plan to make contributions to Ushahidi, consider forking the repository before starting, more about that here)

2. Install Docker Engine

3. Install Make command for the OS you use (parses Makefile)

4. CD into the folder where the code is cloned

5. Copy the text in .env.example into .env

6. Run make start

Running The Platform API

The Platform API will run on port 8080 and if you type in http://localhost:8080/ in a web browser, you will see the default API response:

{"now":"2024-03-01T15:48:59+00:00"}

Now, lets move on to setting up the Platform Web Client!