Auto Update System

Project Details

About

Imagine you have an application that already has numerous clients using it on their server. Now, you want to add a new feature and release it as a new version. Alternatively, you might encounter a bug and fix it. In both scenarios, you need a system that notifies your existing clients to upgrade their current app to the new version or update the bug, similar to how platforms like WordPress, Code Editors, and Operating Systems handle it. By integrating this feature, you can achieve your desired outcome.

Minimum Requirements

PHP Version >= 7.4
Laravel Version >= 8

File Structure

|-- app 
    |-- Http
        |-- Controllers
            |-- ClientAutoUpdateController.php
            |-- DemoAutoUpdateController.php
            |-- DeveloperSectionController.php
    |-- Traits
        |-- AutoUpdateTrait.php
        |-- ENVFilePutContent.php
        |-- JSONFileTrait.php
|-- config 
    |-- auto_update.php
|-- resources 
    |-- views
        |-- bug_update
            |-- index.blade.php
        |-- developer_section
            |-- bug_update_setting.blade.php
            |-- general.blade.php
            |-- index.blade.php
            |-- version_upgrade_setting.blade.php
        |-- includes
            |-- session_message.blade.php
        |-- version_upgrade
            |-- index.blade.php
        |-- dashboard.blade.php    
        |-- layout.blade.php    
|-- routes 
    |-- api.php
    |-- web.php
|-- track 
    |-- control.json
    |-- fetch-data-bug.json
    |-- fetch-data-upgrade.json
    |-- general.json
    |-- sample.json
|-- .env.example

config/auto_update.php

Environement Variable (.ENV) Setting

PRODUCT_MODE=DEMO (or DEVELOPER or CLIENT)
VERSION=1.2.1
BUG_NO=1210

Important Notes

(i) PRODUCT_MODE :

DEVELOPER : To access for developers.
CLIENT : For production I mean when the clients use your application and they can get notification and update.
DEMO : Client's product have to connect with a main server to transfer files and others from main server to client server. So there should be a primary server for this original products of a comapany/organization/personal.
If you want you can customize the attributes.

(ii) For Version Upgrade - you should follow these point for DEMO :

Client Version Number >= Minimum Required Version
In general setting, Latest Version Upgrade should be Checked
Product Mode have to set DEMO
Demo Version Number > Client Version Number

(iii) For Bug Update - you should follow these point in DEMO :

Client Version Number >= Minimum Required Version
Demo Version Number === Client Version Number
Demo Bug Number > Client Bug Number
In general setting, bug update should be Checked
Product Mode have to set DEMO

Developer Section

(This section will be disabled for the clients)

General Setting

Goto the url to access: your_domain_name.com/developer-section
Product mode should be DEVELOPER
Latest Version Upgrade : You have to enable this when a new version will be released so that old clients get notification and can update.
Latest Version DB Migrate : If need to DB migrate, then you have to enable this also.
Version Upgrade URL : In your server, you have to create a directory and all necessary files have to import there so that the files from here can transfer into client server.
Bug Update : Same as like "Latest Version Upgrade".
Bug DB Migrate : Same as like "Latest Version DB Migrate".
Bug Update URL : Same as like "Version Upgrade URL".

Version Upgrade Setting

In Files section you have to input file name which file you want to transfer from your main server to client server.
In Logs section clients can see the change log details.
In Short Note section, you can set a important note for the clients if need.

Bug Update Setting

Similar as like Version Upgrade Setting.

Client Section

Client Dashboard (if version upgrade related)

Goto the url to access: your_domain_name.com/dashboard
If any new version release, then client will get a notification message in dashboard. They have to click on Click Here option to see the details page.

Version Upgrade Page

Client will see all details such version number, note and change log details.

After clicking Upgrade button, it will upgrade process automatically then will see a success message and new version number will setup in your application automatically.

Some Challenge :

If any issues arise, then clients have to contact with the support team.

Client Dashboard (if bug update related)

Goto the url to access: your_domain_name.com/dashboard
If any bug found, then client will get a alert notification message in dashboard. They have to click on Click Here option to see the details page.

Client will see change log and short note (if needed) details.

After clicking update button, it will update process automatically then will see a success message.