Website | Slack | Discord | StackOverflow

An Open Source Framework for building Hyperlocal Delivery Mobile and Web applications. Zinger provides developers easy to handle backend for ordering & delivering foods, groceries, fruits, vegetables, medicines, etc.

  A backend server that exposes the REST API, written in spring boot using MySQL database.

  A customer side application to place and track your orders from multiple store partners near your location. It allows you to browse catalogs of all stores and provides you a seamless shopping experience from order acceptance to last mile delivery.

  A one-stop solution for store owners to manage and track orders from their clients and it provides an effective order and inventory management solutions.

  A web console to monitor the zinger client and partner applications. It is a powerful tool to track application performance, manage outlet information and promotes new arrivals to increase brand engagement.

Check out the database schema

• Java 8 or newer
• MySQL 8.0.19
• Spring Boot 2.2.4

• Fork the Main Repository
• Clone the forked repository locally git clone forked_repo_url

• Open MySQL Workbench
• Run the DB_INIT.sql script to create the tables, indexes and triggers.
• Run the DB_PROC.sql script to create the procedures.
• Run the DB_INSERT.sql script to populate the database.
• Set your MySQL username and password in application.properties

• Create a new Firebase project
• Navigate to Project setting -> Service accounts -> Generate service account -> Generate new private key
• Set your credentials file path in application.properties

• Choose File -> Import -> Maven -> Existing Maven projects
• Right-click MainApplication.java and choose Run As -> Java Application

• Choose File -> Open and choose the project location
• Right-click MainApplication.java and choose Run MainApplication.main()

• Visit localhost:8080 in the browser to check if the setup is successful.
• Test the endpoints in Postman by importing the API collection
• For detailed API documentation, please refer API Docs

If you would like to integrate with any mobile or web application, use Ngrok to get a public URL of your localhost. Also, you can host in any of the online cloud service providers like Heruko, Azure, AWS, etc.

Zinger framework is completely free and made open-source. Our team is really happy to support contributors from all around the world. Fork our project and send us your pull request: maybe sample mobile apps using our framework, minor extensions or major improvements.

Every contribution is awesome and welcome!

• Logesh Dinakaran
• Harshavardhan P

BSD 3-Clause License

Copyright (c) 2020, Logesh Dinakaran
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.