Github

LocatorAPI

Change log

v.0.0.1: Planning

Setup environment

Goal

Get everything you need to build, run and further explore LocatorAPI on your local development environment or production server

Prerequisites

• A DHIS2 server (v 2.36 or higher)

• RO Database User: Create a user in database and provide RO permission to access dhis2 database.

• PostGIS extension installed and enabled

Server Requirement

• Apache Server

• Java JDK 8

Run the site Locally

Installing LocatorAPI

1. Download the ‘war’ file from here or from ‘release’ section in our github page.

2. Move / upload the war file inside the webapps folder of your apache server

3. To configure the application, please create an .env file in the root of your webapps and copy the code below and update its values as required.

   application.url={{host}}
   application.port={{8080}}
   spring.datasource.url=jdbc:postgresql://{{server}}:{{db_port}}/{{database}}
   spring.datasource.username={{username}}
   spring.datasource.password={{passport}}
   
   spring.jpa.show-sql=true
   spring.jpa.hibernate.ddl-auto=update
   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
   spring.jpa.properties.hibernate.format_sql=true

Developers Documentation

App Architecture

API Structure

Creating new Endpoint

Spring Security

Adding new Users

Pull Request