Developer Docs

Downloads

Tip : Right click on the following link’s and click “copy link address” to copy the download link.

Latest Jar filenearby-shops-api-1.14.jar

Sample Configuration file : api_config.properties

Source codeSource code

API Version History

APK File download  :

  1. Shop Owner app
  2. Admin app

Developer Guides 

Nearby Shops API Installation Guide

In this guide we learn how to install Nearby Shops API on the Could Hosting Service like Digital Ocean or AWS using Ubuntu 16.04 Server.

Upgrade Nearby Shops API 

Guide for upgrading the Server Side software

Generate fat jar / uber jar from source code

A fat jar (also called uber jar) is a jar file which contains all of its dependencies. You can simply run it without downloading any library files.

Auto restart Java Process after termination or System Reboot on Ubuntu 16.04 using SystemD

A trivial Java process can get killed, terminated due to various reasons and this is bad because termination of Java API process can terminate your service. In this tutorial we study various strategies how we can restart a Java Process if it gets terminated due to system error or due to  Server Reboot or Restart.

Add and configure Swap Space

Low Memory can become a problem on the Server. Adding a swap space can rescue us from this problem.

Clean Up port 80

Sometimes we might face situations where port 80 is not free and already occupied. So we study various strategy to kill process on port 80 to free up the port 80.

 

Working with Postgres Database

 

Tables and Database Schema for Nearby Shops

In this article the Tables used and the Database Schema for the Nearby Shops application

Enable Remote access to the postgres Database and access throught PGAdmin4

We might need to have read-write access to the postgres Database of Nearby Shops API for various reasons. In this tutorial, we study how can enable remote access to the postgres database installed on the API Server.

Upgrade Postgres Database on Ubuntu 16.04

If you already have postgres installed and you want to upgrade your database to the latest version please refer to this article.

Appendix

  1. Useful terminal Commands Ubuntu 16.04
  2. SystemD Terminal Commands
  3. Useful Tutorials From Digital Ocean

 

Features and Issues Pending

  1. Features and Issues Pending

 

Bookmarks and Notes

  1. Bookmarks
  2. Personal Notes

 

Pending Topics – Coming Soon

Upgrading API

Customize Android Apps

Enable OTP and SMS : MSG91 Integration

Enable Push Notifications : One Signal Integration

Editing API Configuration File

Getting Started for Administrator

 

Setup Local Development Environment

In this tutorial we will see how you can setup the development environment on your own local machine.

Secure your API using  SSL / TLS from LetsEncrypt (Coming Soon)

In this tutorial we will see how we can secure our API using LetsEncrypt free SSL/ TLS certificates

Configure Domain Name for the Service

An IP Address of the Server can change with change in configuration. Therefore we need a friendly domain name. Which remains constant and does not change. A friendly domain is needed to help users remember and identify your service.