Download the PHP package salla/laravel-starter-kit without Composer

On this page you can find all versions of the php package salla/laravel-starter-kit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of salla/laravel-starter-kit

Informations about the package laravel-starter-kit


Logo

Salla Apps Starter Kit

An awesome starter template to create your Salla Apps today!
Explore our blogs »

Report Bug · Request Feature . </Salla Developers>

Table of Contents
  1. Overview
  2. Getting Started
    • Prerequisites
    • Installation
  3. Usage
  4. Configure Authorization Modes
    • Easy Mode
    • Custom Mode
  5. Authorization Service
    • Refreshing a Token
  6. Webhooks
    • Order Related Webhooks/Actions
    • Product Related Webhooks/Actions
    • Shipping Companies Related Webhooks/Actions
    • Customer Related Webhooks/Actions
    • Category Related Webhooks/Actions
    • Brand Related Webhooks/Actions
    • Store Related Webhooks/Actions
    • Cart Related Webhooks/Actions
    • Special Offer Related Webhooks/Actions
    • Miscellaneous Related Webhooks/Actions
  7. Support
  8. Contributing
  9. License

Overview

This is a starter App includes a Laravel application equipped with the required auth processes and webhooks/actions that help you to create your Salla App which works with the Salla APIs. Your App later can be published to the Salla App Store and be available for installation to any of Salla Merchants Stores.

What can you use this starter App for?

Getting Started

The starter App comes with an easy installation steps that do the complete setup for your starter App. To be ready, you will need some prerequisites which will be listed hereafter.

Prerequisites

Before proceeding with the installation, make sure you have the following prerequisites installed on your system:

That is all!

Installation

The installation process is straightforward as you will see in the below steps.

  1. Clone this Repo to your own localhost.
  2. Install Dependencies: npm install and composer install
  3. Generate an Application Key: php artisan key:generate
  4. In your MySql Database: create a database with any name for example laravel.
  5. Update the .env file.

(back to top)

Usage

First you need to create your App in Salla Partner Portal. This is to get the client-id and client-secret. For thatm you may use the Salla CLI.

Run the following command to create your App and follow on-screen instructions.:

Salla App Create Command

(back to top)

Important Note:

If you are using app.store.authorize) via webhook

Output URLs

URL Description
Local App Url The local link for your App.
Remote App Url The online link to your App. It will be always synced with the local Url
Webhook Url The Url link that connects your App with any action that may happen at the Merchant store, e.g. \ncreate new product.
OAuth Callback Url The App entry page where the access token is generated; Note that this Url is available only for the Custom mode auth.

(back to top)

Configure Authorization Modes

While creating your App in the Salla Partners Portal, you will see that Salla provids two methods for the OAuth protocol, which are the Easy Mode and the Custom Mode.

During the setup process, the default OAuth protocol will be set to the Easy Mode, which can be configured from the file .env. All of the setup's values/keys are stored in the .env file as we can see in the below image.

Salla Laravel App folder structure

Easy Mode

This mode is the default mode for the authorization, which means that the access token is generated automatically at Salla's side back to you. You may refer to the class app\Actions\App\StoreAuthorize.php to get more details on how to receive and manage the access token

Custom Mode

A callback Url is the Url that is triggered when the App has been granted authorization. This should be a valid Url to which the merchant's browser is redirected. In this mode, you will need to set a custom callback url from the App dashboard at the Salla Partner Portal. This callback url will redirect the merchants who are interested in using your app into your App entry page where the access token is generated. Moreover, using the Salla CLI command salla app serve, your callback url will be automatically updated.

You may refere to file callback() function. This function is responsible for generating the access token

The custom url will redirect the merchant to the Store Dashboard in order to access the Store where he needs your App to be installed.

(back to top)

Authorization Service

This project comes with a simple singleton authorization service to help you with managing the access and refresh tokens

Refreshing a Token

Access tokens expire after two weeks. Once expired, you will have to refresh a user’s access token. you can easily request a new access token via the current refresh token for any user like this


(back to top)

Webhooks

Webhooks simplify the communication between your App and Salla APIs. In this way, you will be notified whenever your app receives payload/data from the Salla APIs. These webhooks are triggered along with many actions such as an order or product being created, a customer logs in, a coupon is applied, and much more.

Create new Webhook/Action command

Salla already defined a list of the webhooks/actions that are triggered automatically. The predefined webhooks/actions can be found in the folder app/Actions.

Run the following command to create your webhook event:

Salla App Create-Webhook Command

You may find the supported Webhook events as follows:

Order Related Webhooks/Actions

Action Name Description
order.created This indicates a singular order has been created
order.updated Details, data and/or content of a specific order have been refreshed updated
order.status.updated Whenever there is an order status update, this is triggered
order.cancelled This happens when an order is cancelled
order.refunded The refund action to refund the whole order is triggered.
order.deleted This indicates an order has been deleted
order.products.updated Order products is updated
order.payment.updated A payment method has been updated
order.coupon.updated This is triggered whenever a Coupon is updated
order.total.price.updated A total price of an order has been updated
order.shipment.creating This indicates a new shipment is being created
order.shipment.created This indicates a new shipment has been created
order.shipment.cancelled This indicates a an order shipment has been cancelled
order.shipment.return.creating This is triggered when a returned order shipment is being created
order.shipment.return.created This is triggered when a returned order shipment has been created
order.shipment.return.cancelled This is triggered when a returned order shipment has been cancelled
order.shipping.address.updated Occurs when an Order shipping address is updated

(back to top)

Product Related Webhooks/Actions

Action Name Description
product.created A new product is created. Payload of the new product are to accompanying the product
product.updated Add/Modify details of a product
product.deleted Delete a product along with all its variants and images
product.available Flags a product as stock available
product.quantity.low Shows warnings whenever a stock is of low quantity

(back to top)

Shipping Companies Related Webhooks/Actions

Action Name Description
shipping.zone.created This is triggered when a shipping zone has been created for a custom shipping company
shipping.zone.updated This is triggered when a shipping zone has been updated for a custom shipping company
shipping.company.created This is triggered when a custom shipping company has been created
shipping.company.updated This is triggered when a custom shipping company has been updated
shipping.company.deleted This is triggered when a custom shipping company has been deleted

(back to top)

Customer Related Webhooks/Actions

Action Name Description
customer.created Create a new customer record
customer.updated Update details for a customer
customer.login Triggered whenever a customer log in
customer.otp.request One-Time Password request for a customer

(back to top)

Category Related Webhooks/Actions

Action Name Description
category.created Creates a new category for products to be put under
category.updated Add new or reform existing category details

(back to top)

Brand Related Webhooks/Actions

Action Name Description
brand.created Creates a new Brand.
brand.updated Triggered when Information about a sepcific Brand is updated/refurbished/streamlined
brand.deleted An existing brand is then deleted and removed from a store

(back to top)

Store Related Webhooks/Actions

Action Name Description
store.branch.created Creates a new store.
store.branch.updated Updates an existing branch
store.branch.setDefault Sets for default a specific branch
store.branch.activated Activates a disabled branch
store.branch.deleted Deletes a branch
storetax.created Creats a new Store Tax

(back to top)

Cart Related Webhooks/Actions

Action Name Description
abandoned.cart Outputs a list of abandoned carts
coupon.applied Creates a discount code in the form of a coupon

(back to top)

Special Offer Related Webhooks/Actions

Action Name Description
specialoffer.created Creates a new special offer
specialoffer.updated Updates a special offer

(back to top)

Miscellaneous Related Webhooks/Actions

Action Name Description
review.added A product review has been added

(back to top)

Support

The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on Github using the Issue Tracker. If you still have any questions, please contact us via the Telegram Bot or join in the Global Developer Community on Telegram.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

(back to top)

All versions of laravel-starter-kit with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3|^8.0
fruitcake/php-cors Version ^1.0
guzzlehttp/guzzle Version ^7.0.1
inertiajs/inertia-laravel Version ^1.0
laravel/framework Version ^11.0
laravel/sanctum Version ^4.0
laravel/tinker Version ^2.5
laravel/ui Version ^4.0
lorisleiva/laravel-actions Version ^2.1
salla/ouath2-merchant Version ^1.0
tightenco/ziggy Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package salla/laravel-starter-kit contains the following files

Loading the files please wait ....