Self-Hosted Mobile Based Hyperlocal and Food Delivery Platform
Commercial Use Permitted
All the source code of Nearby Shops Open-Source project is released under a liberal MIT license which allows you to use this software for commercial use.
Nearby Shops is an Open-Source food delivery, grocery and Hyperlocal platform. You can install your self-hosted instance on Digital Ocean or AWS and get your grocery or food delivery market up and running in just 5 $ per month hosting fee.
Nearby Shops implements Alibaba’s Grocery online-and-offline Concept. Where customers can place order from the app and pick their orders from the shop.
The installation guide and app customization guide is provided at http://developer.nearbyshops.org
Website : https://nearbyshops.org | Developers Guide: http://developer.nearbyshops.org
đ© Table of Contents
- Concept
- Tech Stack and App Architecture
- Features and highlights
- Screenshots
- Libraries Used
- Third Party Integrations
- Community forum
- Source Code for Shop Owner and Admin app and REST API
- Contributions Required
- Development Instructions
- Commercial Use
- License
Concept
Nearby Shops is a Hyerlocal Shopping platform where a customer can buy directly from the shops available in his/her local area and get his orders delivered to the home or just pick the order from the shop if home delivery is not available.
In the new emerging world customers are getting tired of daily shopping routine of going outside for shopping. They would much prefer if they can simply place an order and get the products delivered to their Home the same day.
The conventional e-commerce has issues … the delivery takes a long time and its more difficult to trust the vendors which you cannot see and meet physically. Hyperlocal e-commerce tends to solve these issues because delivery is faster and customers can reach out to the vendors easily.
Nearby Shops can also be used as a food Delivery platform where restaurants can use it to deliver food instead of items.
Nearby Shops implements Alibaba’s New Offline-to-Online Concept where customers discover products online and then pick those products from Physical Stores.
Tech Stack and app Architecture
Uses Android Jetpack and Googleâs Recommended Architecture Patterns – Migeration to MVVM is planned
Written in both Java and Kotlin : Migeration to kotlin is planned and will be coming in near future
Built using Butterknife, Retrofit, Ok-HTTP, Picasso, Dagger, Mapbox android SDK
Software is made of modular View-Holder Pattern which makes the UI blocks modular and easy to reuse, modify and understand.
The app uses Single activity Architecture where most of the screens are implemented as fragments and there are only 2-3 activities in the entire project.
The project has 3 android apps each for End-User, Shop-Owner and adminstrator and a JSON based REST API at the backend. The Source for REST API is provided.
Features and Highlights
Mobile Based – Multi-Vendor Platform where customers can send orders to multiple shops / Restaurants
Integrations for Sending SMS-OTP, E-mail and Push Notifications are available
Order Tracking with Live status updates for Customer using e-mail, SMS and Push Notifications
Rating and Reviews for Items and Shops
Home Delivery and Pick From Shop (Online-to-Offline) Shopping Concept is Supported
Location Based Filtering is available which means that customers will see only those shops which can deliver to their address and other shops will get filtered out.
Vendors / Shop-Owners can track order’s through orders inventory and update the order progress !
Shop-Owners can deliver order by themselves by adding delivery staff. Shared Delivery Logistics will also be available which we are planning to implement in future releases of Nearby Shops.
Billing and Payments are supported … Shop-owners are billed according to number of orders they deliver successfully. And Service Providers (Market Owners) can collect payments from the shop-owners.
Commercial Use – This is not just an hobby project and you can actually use it to setup your business and Earn some real money.
Screenshots
Libraries Used
Android-Jetpack, Retrofit, Ok-Http, Event-Bus, Picasso, butterknife, dagger2, U-Crop, Gesture Views, Smiley Rating, Mapbox Android SDK
Third Party Integrations
Nearby Shops has latest integrations for SMS-OTP verification(MSG91), E-mail (Simple-Java-Mail), One-Signal and Firebase (for push notifications), Mapbox Android SDK for Maps
Community – Need Help ?
If you want any help regarding anything. Feel free to contact us. Send a message through our forum or you can simply post an issue. Your issues will not be ignored and you will surely receive help.
Reach out to us – Please Visit – https://forum.nearbyshops.org
Source code for Shop-Owner, Admin app and Server Side
If you want to see source code for Shop-Owner app, Admin-app and server side the links are provided below
Shop-Owner app : https://github.com/SumeetMoray/Nearby-Shops-Shop-Owner-Android-app
Admin app : https://github.com/SumeetMoray/Nearby-Shops-Admin-App
Source code for Server Side JSON Based REST API is available in this repository https://github.com/SumeetMoray/Nearby-Shops-API
Contributions in following Areas are welcome
https://forum.nearbyshops.org/t/project-roadmap-and-contributions-required/34/4
Development Instructions
If you’re a developer looking to work on the source code follow these instructions to start developing !
git clone https://github.com/SumeetMoray/Nearby-Shops-End-User-Android-app.git
You should now open the project with the latest version of Android Studio. The project will not compile unless you add the following property in the local.properties file.
This project uses mapbox android sdk which requires mapbox style url. To add the style url in the project open this project in the android studio and add the Mapbox Style URL in the local.properties file.
It is okay if you dont have an actual Mapbox style url in that case just put some dummy text in place of url.
mapbox_style_url="your-mapbox-style-url"
All the source code of Nearby Shops Open-Source project is released under a liberal MIT license which allows you to use this software for commercial use.
The MIT License (MIT)
Copyright 2017-19 Bluetree Software LLP, Inc. | http://nearbyshops.org
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the âSoftwareâ), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED âAS ISâ, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
