Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 4.19 KB

README.md

File metadata and controls

90 lines (70 loc) · 4.19 KB

Zinger Framework

Build your own Ecommerce Marketplace 🛍️

Website | Slack | Discord | StackOverflow

License Documentation PRs Welcome

An Open Source Framework for building Ecommerce marketplace solutions, offering highly flexible backend system that enables the developers to manage shops, inventory, orders and discounts along with authentication, order fulfilment, webhook notifications and various payment integrations.

Architecture

Zinger Core

  A backend server that exposes the REST API, written in Ruby on Rails using PostgreSQL database and Redis cache. It also exclusively uses Elastic Search for searching inventory, shops, etc.

  Zinger Client is a frontend application built in Angular, incorporating Zinger Admin and Zinger Platform for managing admin and platform specific operations respectively.

Zinger Admin

  A web dashboard providing a one-stop solution for shop employees to manage and track orders from their clients and it provides an effective order and inventory management solutions.

Zinger Platform

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

  A customer-side mobile 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.

Database Schema

Check out the database schema

Tech Stacks

  • Rails 6
  • PostgreSQL 12.1
  • Redis

Prerequisites

Install Applications

  • Docker Desktop

Update Hosts

Add the below lines to your hosts file to run the application in custom subdomain.

127.0.0.1	api.zinger.pw
127.0.0.1	admin.zinger.pw 
127.0.0.1	platform.zinger.pw

Host file location

  • Linux/Mac - /etc/hosts
  • Windows - C:\Windows\System32\drivers\etc\hosts

Setup instructions

Fork Project

  • Fork the main repository
  • Clone the forked repository locally git clone forked_repo_url

Run Project

Deploy

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.

Community

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 storefronts using our framework, minor extensions or major improvements.

Every contribution is awesome and welcome!