Skip to content

varsitymarket-technologies/vm.embedded.store

Repository files navigation

< VM.EMBEDDED SITES >

VM.EMBEDDED.SITES

A lightweight, plug-and-play e-commerce micro-service.Turn any static page (Google Sites, Cloudflare Pages, Github pages) into a fully functional storefront.

What is vm.embedded.sites ?

vm.embedded.sites is a self-hosted e-commerce plugin designed for users who need a professional shop without the overhead of developing a custom application. It splits into two parts: a high -performance Shop Frontend for customers and a robust Admin Control Panel for mnagement.

Guide Section

Why use this?

  • Zero-Friction Intergration: Embed via <iframe> or simply export your page into a single exported web page.
  • Lightweight: No heavy databases or complex dependencies required.
  • Decoupled Management: Update your products in the Admin Panel; the changes will instantly be reflected on your static website.

App Features

Shop Frontend

  • SPE Architecture: Single Page Expirience [Shop, Product, and Checkout views transition without reloads].
  • Responsive: Optimized for mobile shoppers using Bootstrap 5.
  • Page Designs: The page themes allow you to change your store designs to how you want your store to look like.
  • Simple Export: This tool exports your page into two formats <iframe> or <source code>. This makes it easy to embed the store to your static web page.

Admin Control Panel

Admin UI Preview

  • Compehensive Management: Dedicated pages for User Roles, Product Catalogs, Order Tracking.

Creating Your Own Template

The system allows users to create their own themes. Please Read the theme.md file. Go To Doc

Tech Stack

| Section | Technologies | | --- | --- | --- | | Backend | PHP 7.4+ | | Shop UI | Tailwind CSS, JS |

Database & CLI Tools

The system includes built-in services for database health and backups via the PHP CLI.

  • Initialize/Restart Database:
php services/sys.database.php
  • Create Manual Backup:
php services/sys.database.backup.php
  • Restore from Rollback:
php services/sys.database.restore.php [backup_file]
# example: php /services/sys.database.restore.php /build/engine.backup

API Reference

The frontend fetches data from api.php.

Products

Endpoint: Get api.php?state=products

  • Function: Returns all the products in the Micro Store Application.

Category

Endpoint: Get api.php?state=categories

  • Function: Returns all the products in the Micro Store Application.

About

A lightweight, embedded e-commerce micro-service designed to act as a plugin for static website pages. This project provides a complete solution with a customer-facing shop and a comprehensive admin control panel.

Topics

Resources

Stars

Watchers

Forks

Contributors