https://github.com/ventrec/laravel-entity-sync-endpoint

Handles incoming sync requests from the laravel entity sync package.
https://github.com/ventrec/laravel-entity-sync-endpoint

Last synced: about 2 months ago
JSON representation

Handles incoming sync requests from the laravel entity sync package.

• Host: GitHub
• URL: https://github.com/ventrec/laravel-entity-sync-endpoint
• Owner: ventrec
• License: mit
• Created: 2017-10-15T21:02:56.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-29T19:10:37.000Z (about 7 years ago)
• Last Synced: 2024-10-27T02:06:17.168Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 13.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel entity sync client

[![Latest Version on Packagist](https://img.shields.io/packagist/v/ventrec/laravel-entity-sync-endpoint.svg?style=flat-square)](https://packagist.org/packages/ventrec/laravel-entity-sync-endpoint)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://img.shields.io/travis/ventrec/laravel-entity-sync-endpoint/master.svg?style=flat-square)](https://travis-ci.org/ventrec/laravel-entity-sync-endpoint)

[![Total Downloads](https://img.shields.io/packagist/dt/ventrec/laravel-entity-sync-endpoint.svg?style=flat-square)](https://packagist.org/packages/ventrec/laravel-entity-sync-endpoint)

Handles incoming sync requests for the [laravel entity sync](https://github.com/ventrec/laravel-entity-sync) package.

## Introduction

This is the client package of the [laravel entity sync](https://github.com/ventrec/laravel-entity-sync) package. The [laravel entity sync](https://github.com/ventrec/laravel-entity-sync) package syncs entities to the endpoints that this package creates. This package will then handle the data and create, update or delete the entity.

The structure of your tables should be the same on both the master database and the client database.

## Installation

1. `composer require ventrec/laravel-entity-sync-endpoint`

2. Add `Ventrec\LaravelEntitySyncClient\LaravelEntitySyncClientProvider::class` to providers in app.php

3. Publish the config file `php artisan vendor:publish --provider="Ventrec\LaravelEntitySyncClient\LaravelEntitySyncClientProvider"`

4. Update the config file

    - Add the entities that you expect to receive requests for. This should be the same entities that you have entered in the master config.

    - Enter an api token that should be used to verify the requests. This should be the same token that was used in the master config.

    - (Optional) Enter a prefix for the api-endpoint. If no prefix is entered, all requests will be sent to `/entity-sync`

## Usage

All models that is used must have `protected $guarded = []`.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.