Overview

Zajel is a robust multi-vendor e-commerce core and boilerplate designed specifically for developers. It provides a solid architectural foundation combining a Laravel backend (API), a Node.js automation bot, and a Flutter mobile app. Instead of wasting weeks configuring API routing, database architecture, and bot event-listeners, Zajel gives you a clean, stable, and production-ready starter kit to build upon.

⚠️ IMPORTANT DISCLAIMER (Please Read Before Buying)

Developer Tool: This project is sold as a Boilerplate / Starter Kit, not a consumer-ready retail product. It is strictly intended for developers to extend, modify, and customize.

Core Architecture: It contains all core architectural setups (API routes, database schema, bot architecture) and is completely stable and crash-free.

Omitted Logic by Design: Advanced business logic (such as automatic stock/inventory deduction upon checkout) is omitted by design, allowing developers to implement their own logic easily.

No Payment Gateways: This core setup does not include built-in online payment gateways. Orders are processed as pending requests routed straight to vendors.

Key Features & Components

💡 Note: This is a developer-focused boilerplate. By purchasing, you confirm you have the required coding skills to customize it. We do not provide free custom development or hosting support.

🖥️ 1. Laravel Backend & API Core

Core Vendor Dashboard: An essential interface for registered vendors to track basic sales metrics and manage products.

API-Driven Architecture: All main endpoints are clean, decoupled, and securely structured inside app/Http/Controllers/Api.

Flexible Database Support: Pre-configured with SQLite for a zero-setup "Plug & Play" testing experience, with seamless configuration support for MySQL production databases.

📱 2. Flutter Buyer Application

User-Centric UI: Built for buyers/end-users to smoothly browse multiple local stores, explore products, and manage their shopping cart.

Decoupled Services: Easy-to-configure centralized API service files to map your custom URLs instantly.

💬 3. Node.js WhatsApp Automation Bot

Instant Order Routing: Automatically captures successful cart checkouts and notifies the vendor instantly on WhatsApp.

Bidirectional Alerts: Keeps the customer informed with status updates once the vendor accepts or updates the order status.

Session Management: Includes a dedicated initialization script (bot_qr.js) to effortlessly map and link your WhatsApp device via QR web-auth.

Tech Stack & Tested Versions

Backend Framework: Laravel v13.11.2

Programming Language: PHP v8.3.8

Mobile Framework: Flutter v3.44.0

Automation Bot: Node.js v24.18.0

🛠️ Technical Support & Scope Policy

Please read this policy carefully before requesting support on the platform:

What Support Covers: We strictly provide support for critical runtime bugs or core architectural crashes that prevent the boilerplate from running as a fresh installation.

What Support DOES NOT Cover:

Custom feature requests or extending the business logic (e.g., adding automated inventory features, modifying payment gateways, customizing the UI).

Server configuration, hosting deployment, environment setup, or publishing assistance on Google Play / App Store.

General programming consultation or teaching how to use Laravel/Flutter.

By purchasing this item, you acknowledge that you possess the necessary technical skills to manage, expand, and finalize this boilerplate according to your project requirements.

Key Features & Highlights

🖥️ Backend & Core API (Laravel)

Multi-Vendor Architecture: Built-in multi-tenant database structure supporting multiple independent local vendors.

Essential Vendor Dashboard: A clean, minimal web dashboard for registered vendors to view basic sales metrics and manage products/categories.

Decoupled RESTful API: 100% API-driven endpoints cleanly structured inside app/Http/Controllers/Api for effortless frontend integration.

Plug & Play SQLite Database: Pre-configured with SQLite out-of-the-box for a zero-configuration, instant testing environment.

Production MySQL Ready: Seamlessly swap to a production-grade MySQL database by simply editing environment variables.

Database Seeders & Migrations: Includes sample data seeders to populate your marketplace with test vendors and products instantly.

📱 Mobile Buyer Application (Flutter)

Clean UI/UX Design: A modern, user-friendly mobile interface designed specifically for buyers/end-users.

Multi-Store Browsing: Smooth exploration of multiple local stores and vendor catalogs in one unified application.

Advanced Cart System: Fully functional local shopping cart management for adding, updating, and preparing orders.

Centralized API Services: Decoupled and organized API service layer to map and update your backend URLs instantly.

💬 Automation Bot (Node.js & WhatsApp)

Real-Time Order Routing: Automatically intercepts successful checkouts and forwards detailed order receipts straight to the vendor’s WhatsApp.

Bidirectional Alerts: Automatically triggers instant WhatsApp notifications to the buyer whenever a vendor updates or accepts an order status.

Seamless QR Web-Auth: Includes a lightweight web-auth script (bot_qr.js) to pair your mobile WhatsApp session instantly via QR code.

Process-Manager Friendly: Production-ready script structured to run 24/7 in the background using PM2 daemon processes.

🛠️ Developer Experience (DX)

Clean & Commented Code: Strictly written following modern PSR/Dart linting standards and architectural best practices.

No Crash Environment: Fully stable codebase tested comprehensively on standard local environments.

Extensive Documentation: Includes a clear step-by-step installation guide, troubleshooting tips, and setup instructions.

System & Technical Requirements

To ensure a smooth setup and deployment of the Zajel boilerplate, your development environment and technical skills must meet the following prerequisites.

🖥️ 1. Software & Environment Requirements

Backend Framework (Laravel API)

PHP Version: v8.3.8 or higher.

Composer: v2.x (Required to install dependencies and generate core vendor files).

Required PHP Extensions (Crucial): Ensure that openssl, zip, intl, pdo_sqlite, and pdo_mysql are fully enabled in your local php.ini configuration.

Mobile Framework (Flutter Application)

Flutter SDK: v3.44.0 or higher.

Dart SDK: v3.x or higher.

IDE: Android Studio or VS Code with Flutter/Dart plugins installed.

Network Setup: Ability to configure and expose local development hosts (e.g., executing php artisan serve --host=0.0.0.0) to allow physical mobile devices or emulators to communicate with the local Laravel API.

Automation Core (WhatsApp Bot)

Node.js: v24.18.0 or higher.

NPM: Installed and configured to manage JavaScript package dependencies.

Database & Hosting

Database: SQLite (Pre-configured for an instant, zero-setup testing experience) or MySQL v8.0+ (For production environments).

Production Deployment (Recommended): A Linux-based VPS (such as Ubuntu) with SSH terminal access. This is highly recommended to run the Node.js WhatsApp bot 24/7 using process managers like PM2.

2. Required Programming & Technical Skills

This product is a developer-focused core boilerplate, not a retail end-user application. The purchaser is expected to have practical knowledge in the following areas:

Laravel Ecosystem: Solid understanding of MVC architecture, Eloquent ORM, database migrations, seeders, and RESTful API structures.

Flutter & Dart: Experience in fetching package dependencies via pubspec.yaml, handling asset links, and compiling/building debug or release binaries (.apk / .ipa).

Node.js & Session Management: Basic familiarity with JavaScript environments to run back-end scripts, initialize QR-code authentications, and monitor script lifecycles.

CLI / Terminal Command Line: Comfort executing commands via Terminal, Command Prompt, or PowerShell (such as running migrations, installing npm packages, or triggering artisan commands).

Quick-Start Setup Instructions

This file provides a high-level roadmap to get the Zajel environment up and running. For a detailed guide, please refer to the comprehensive DOCUMENTATION.md file included inside the root folder.

📁 Step 1: Extract the Package

Unzip the downloaded archive. You will find three main directories:

zajel_backend/ (Laravel API Core)

zajel_flutter/ (Flutter Mobile App)

zajel_bot/ (Node.js WhatsApp Automation)

🖥️ Step 2: Setup Laravel Backend & API

Navigate to the zajel_backend/ directory in your terminal and run the following commands sequentially:

Install PHP Dependencies:

composer install

Troubleshooting Conflict: If Git or network protocols fail during installation, run:

composer config --global http-protocols http

composer clear-cache

composer install

Environment Configuration:

cp .env.example .env

php artisan key:generate

Link Storage for Images:

php artisan storage:link

Troubleshooting Broken Images: If the storage folder exists inside public but images fail to display, manually delete the storage link from the public/ directory, and run php artisan storage:link again.

Database Migrations & Seeders:

php artisan migrate:fresh --seed

Run the API Server:

php artisan serve --host=0.0.0.0

📱 Step 3: Setup Flutter Mobile App

Navigate to the zajel_flutter/ directory in your terminal:

Fetch Dependencies:

flutter pub get

Generate Code Layouts:

dart run build_runner build

Launch the App: Ensure your local backend configuration URL points to your hosting or local IP, then execute:

flutter run

💬 Step 4: Setup WhatsApp Automation Bot

Navigate to the zajel_bot/ directory in your terminal:

Install Node Packages:

npm install

Link WhatsApp Account: Run the initialization script to scan the WhatsApp Web QR code:

node bot_qr.js

Execute Active Listening: Once paired, run the active automation server:

node bot.js

(For 24/7 production environments, running the script via PM2 is highly recommended).