Skip to content

This is a server side JSON Based REST API for Nearby Shops local e-commerce software

License

Notifications You must be signed in to change notification settings

Amuri-Bonface/Nearby-Shops-API-1

Repository files navigation

Nearby Shops API (JSON based REST API)

This is the server side part of the Nearby Shops open-source project. For more information about this project please visit https://nearbyshops.org | Developers Visit : https://developer.nearbyshops.org

A note to potential Contributors

This repository is due for some code cleanup and refactoring. When that cleanup is done the code will become more easy to understand and comprehend. You can still go ahead and study the code. But be aware that you may not see a production quality organized code.

You are free to review the code and welcome to suggest the best technologies/ libraries to use in the backend side and how can we improve the code in this repository.

If you're an experienced backend developer your inputs will be highly valuable to improve the project code !

To give your suggestion ... get in touch with us on our forum http://forum.nearbyshops.org

Screenshots

Installation Guide

Installation guide is available for installing Nearby Shops API on the Could Hosting Service like Digital Ocean or AWS using Ubuntu 16.04 Server.

For the installation guide please refer the Developer Section on https://developer.nearbyshops.org

Technology Stack

The server side component is a JSON Based Rest API built with Java

  1. Postgres DB as a Primary Database
  2. Jersey Framework – (JAX-RS Implementation) for REST API Endpoints
  3. Jetty Server as an Embedded HTTP Server in the app
  4. HikariCP for Connection Pooling
  5. Thumbnailator for Generating resized versions of Images and thumbnails

Third Party Integrations

SMS-OTP Integration using msg91, One-Signal (for push notifications)

Please visit our integrations guide for more information about integrations : https://developer.nearbyshops.org/integrations/e-mail-integration.html

Download

Get it from Google play store

Get it on Google Play

Get paid to Contribute

Developer time is valuable and its not fair to expect developers to contribute their time without being reasonably compensated.

We may have some strategy / plan to compensate the contributors.

Community and Discussion Forum

Do you have questions ? Need help ? you can speak with original developers of this project. We welcome you to join our forum for discussion on anything related to this project !

Please visit : https://forum.nearbyshops.org

Client Side Repositories

End-User android app : https://github.com/nearbyshops/Nearby-Shops-End-User-Android-app

Shop-Owner android app : https://github.com/NearbyShops/Nearby-Shops-Shop-Owner-Android-app

Admin android app : https://github.com/NearbyShops/Nearby-Shops-Admin-App

About Nearby Shops - How it Works ?

Nearby Shops is a distributed ecosystem of local markets conceptually similar to Mastadon project. Anyone can self-host their Local Market Instance and create their local market on Nearby Shops. The technology is fully open-source and funded by Donations. We dont charge any fee or comission in order to use the platform.

Although the platform and technology is free but Service Providers (Market Creators) are allowed to charge for their services in order to recover their expenses and cost of human efforts and Man-Hours. You can make a reasonable middle-class income if your local market gets a decent enough traction.

Local Market's are generally self-hosted by independent Volunteers, Service Providers and local vendor cooperatives who seek the welfare of their local vendors.

Nearby Shops helps you build your own local market for food delivery or Grocery delivery similar to Zomato, Swiggy, Dunzo, Grubhub and Rappi. This project comes with a comprehensive developer guide which makes it really easy and simple to start using this project. You dont even need to be a developer and just having basic knowledge of installing and working with software in enough for you.

License

Copyright 2018-19 Bluetree Software LLP.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

This is a server side JSON Based REST API for Nearby Shops local e-commerce software

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages