Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.

Commit 31b811d

Browse files
committed
Update documentation
1 parent c5dea48 commit 31b811d

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

docs/getting-started/configurations.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configurations
22

3-
With the installation of Shopper you will find new configurations files located at `config/shopper.php`, `config/larasap.php`, `config/scout.php`, `config/currencyConverter.php`, `config/laravellocalization.php` and `config/cartalyst.sentinel.php`.
3+
With the installation of Shopper you will find new configurations files located at `config/shopper.php`, `config/ttwiter.php`, `config/scout.php`, `config/currencyConverter.php`, `config/laravellocalization.php` and `config/cartalyst.sentinel.php`.
44
And the `shopper.php` file is main for platform, you can find various options to change the configuration of your Shopper installation.
55

66
{% hint style="info" %}
@@ -10,8 +10,7 @@ If you cache your configuration files please make sure to run `php artisan confi
1010
Below we will dive into the configuration file and give a detailed description of each configuration set.
1111

1212
{% hint style="info" %}
13-
**Laravel Scout**
14-
It is important to mention that Shopper works with Laravel Scout, by default Algolia is used. Full documentation of Laravel scout [here](https://laravel.com/docs/5.8/scout)
13+
**Laravel Scout** It is important to mention that Shopper works with Laravel Scout, by default Algolia is used. Full documentation of Laravel scout [here](https://laravel.com/docs/5.8/scout)
1514
{% endhint %}
1615

1716
## Dashboard prefix
@@ -21,6 +20,7 @@ It is important to mention that Shopper works with Laravel Scout, by default Alg
2120

2221
'prefix' => env('DASHBOARD_PREFIX', 'console'),
2322
```
23+
2424
The system installed on the website can be easily defined by the dashboard prefix, for example it is `wp-admin` for WordPress, and it gives an opportunity to automatically search for old vulnerable versions of software and gain control over it.
2525

2626
There are other reasons but we won't speak of them in this section. The point is that Shopper allows to change dashboard prefix to every other name, `admin` or `administrator` for example.
@@ -32,6 +32,7 @@ There are other reasons but we won't speak of them in this section. The point is
3232

3333
'currency' => env('CURRENCY_SYMBOL', 'XAF'),
3434
```
35+
3536
This value of the default currency for your store. It is the default value set in the database `shopper_settings` table.
3637

3738
## Additional resources
@@ -88,14 +89,15 @@ You may add as much new middlewares as you want, as example the middleware for I
8889
],
8990
```
9091

91-
Shopper provide 2 folders for storage. The `uploads` folder contain all public and protected files that uploaded by administration forms (products, categories, brands and users images).
92-
The second folder `media` is for the `filemanager`. You nedd to create this folder in the Media Menu on Shopper admin dashboard.
92+
Shopper provide 2 folders for storage. The `uploads` folder contain all public and protected files that uploaded by administration forms \(products, categories, brands and users images\). The second folder `media` is for the `filemanager`. You nedd to create this folder in the Media Menu on Shopper admin dashboard.
9393

9494
## Others config
9595

9696
Shopper has many other configurations files as we said. Shopper come with
97-
- [Scout Extended](https://github.com/algolia/scout-extended): To provide admin product, category, brand and user research
98-
- [Laravel Localization](https://github.com/mcamara/laravel-localization): To make dashboard localization
99-
- [Sentinel](https://github.com/cartalyst/sentinel): the auth provider of Laravel Shopper admin
100-
- [Laravel Cconverter](https://github.com/danielme85/laravel-cconverter): to provide money format and money convertion
101-
- [Larasap](https://github.com/alihesari/laravel-social-auto-posting): to publish product to your Facebook Page and Twitter account
97+
98+
* [Scout Extended](https://github.com/algolia/scout-extended): To provide admin product, category, brand and user research
99+
* [Laravel Localization](https://github.com/mcamara/laravel-localization): To make dashboard localization
100+
* [Sentinel](https://github.com/cartalyst/sentinel): the auth provider of Laravel Shopper admin
101+
* [Laravel Cconverter](https://github.com/danielme85/laravel-cconverter): to provide money format and money convertion
102+
* [thujohn/twitter](https://github.com/thujohn/twitter): to easily manage Twitter API
103+

docs/getting-started/upgrading.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The `shopper.php` configuration file has had a few changes.
2121
the settings
2222

2323
```php
24+
<?php
2425
/*
2526
|--------------------------------------------------------------------------
2627
| Twitter API key
@@ -47,6 +48,7 @@ the settings
4748
'page_access_token' => env('FACEBOOK_PAGE_ACCESS_TOKEN', '')
4849
],
4950
...
51+
5052
```
5153

5254
was added. This allows you to post to your Twitter account and Facebook page using Shopper core code.

docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
Welcome to the Shopper documentation for version 1.x. This documentation will teach you how to install, configure, and use Laravel Shopper so that way you can create and manage your online store!
3+
Welcome to the Shopper documentation for version 1.1. This documentation will teach you how to install, configure, and use Laravel Shopper so that way you can create and manage your online store!
44
It is shipped as a package for Laravel and can be easily integrated using Composer.
55

66
![Shopper Screenshot](https://i.ibb.co/SxWLWn5/shopper-cover.png)

0 commit comments

Comments
 (0)