initialization.md

Customization

Once you have installed Shopper, you need to set up a store to serve as your first location. After creating a new user, you have to logged in via the url /shopper/login. After logging in, if it's your first time, you'll be redirected to your store's initialization page. This step is essential for your store's basic information (country, currencies, location).

Store initialization

Defines your shop’s address country and state, where you are based as a seller. It determines default tax rates and customer locations.

Global

All these data are stored using the Setting Model which is located \Shopper\Core\Models\Setting

Fields

Name	Type	Notes
id	autoinc
key	string	Unique, the configuration key that will be used to retrieve this information.
display_name	string	Nullable, represents the display name for the key that has been set for better reading
value	json	Nullable, represents the value of the key that will be displayed when the parameter is requested
locked	boolean	default is false (0), allows to define if this parameter can be updated

Retrieving setting

To retrieve the value of a key you can use the helper function shopper_setting() passing the desired key as param

shopper_setting('my_key')

This value is cached for one day and under the key shopper-setting-{$key}. But if you don't want the data to be cached, and you want to receive the last value every time, set false as the second parameter.

shopper_setting('my_key', withCache: false)

Store

When you launch your store the first important thing to do is to fill in the information about this store. Your customers and the different services you might use need to know the information about your store.

Store information

The information stored in this section is available using the following keys: shop_name for the store name, shop_email for the email and shop_country_id for the Country.

Currency

Choose the default currency for the store. Only one may be selected.

Store currency

For currency configurations we use the akaunting/laravel-money package. At the moment, the formatter does it automatically depending on the currency.

As you may have noticed in the code, there is also a helper that returns the currency you registered shopper_currency(). This will return the currency configured in your admin panel: USD, XAF, EUR, etc

Address

Most stores keep their products in different locations around the world. When setting up this configuration you need to define a location that will be set as the default location for your products.

When shipping an order, the products to be delivered/shipped will start from this location and thus the shipping price can be set according to this.

Store location address

The keys registered in the database during this section: street_address, zipcode, city, phone_number, lng and lat.

:::warning If you modify the Livewire component that takes care of registering those information you can also decide to change the name of its keys. :::

Channel

In today's E-commerce the shop site is no longer the only point of sale.

Channels represent a single sales channel, which can be one of the following things:

• Website
• Mobile application
• Cashier in your physical store
• Facebook shop,
• Instagram shop,
• etc

or pretty much anything similar you can imagine.

During the shopper installation, with the execution of the seeder ShopperSeeder, we create a default sale channel named Web Store .

(new ChannelRepository())->create([
  'name' => $name = __('Web Store'),
  'slug' => $name,
  'url' => env('APP_URL'),
  'is_default' => true,
]);

This sales channel will be automatically assigned to all products that are added to your site. The implementation of a sales channel management will be done later

Social Links

If you want your customers to find you easily on social networks, you can fill in all the links directly by putting the full url.

This step is completely optional

Store social links

The keys registered in the database during this section: shop_facebook_link, shop_instagram_link and shop_twitter_link.

Update setting

You can update your store information when needed, edit your store images, update the complete address, the legal name of your shop, etc.

Laravel Shopper at the moment doesn't manage several currencies so you must select with what currency you will sell on your site.

To edit your shop information, you must:

• From your administration, on the blue sidebar click on the settings icon at the bottom of the page Settings > General

Admin setting

The component used to update store setting of the store is found in the component configuration file config/shopper/components.php, It's the Shopper\Framework\Http\Livewire\Settings\General component.

use Shopper\Http\Livewire\Components;

return [
  'livewire' => [

    'settings.inventories.create' => Components\Settings\Inventories\Create::class,
    'settings.inventories.edit' => Components\Settings\Inventories\Edit::class,
    'settings.general' => Components\Settings\General::class, // [tl! focus]
    'settings.legal.privacy' => Components\Settings\Legal\Privacy::class,
    'settings.legal.refund' => Components\Settings\Legal\Refund::class,

  ];

];

Admin update setting

In this interface you will update your store. Don't forget that the model used is the model Shopper\Core\Models\Setting.

With the Shopper configuration you can completely change the architecture of this view and the data stored in the database.