DOCUMENTATION

EStore Documentation
V 1.0.0
Bad_X
08-Jul-20

This is the full documentation for PHP script EStore.

Contents
About............................................................................................................................................... 1
Requirements .................................................................................................................................. 2
Getting Started ................................................................................................................................ 2
Installation....................................................................................................................................... 2
Default Login ................................................................................................................................ 10
Admin Dashboard ......................................................................................................................... 11
Dashboard.................................................................................................................................. 12
Products ..................................................................................................................................... 12
Orders ........................................................................................................................................ 13
Categories .................................................................................................................................. 13
Posts .......................................................................................................................................... 14
Pages.......................................................................................................................................... 15
Users .......................................................................................................................................... 16
Roles .......................................................................................................................................... 17
Media Manager ......................................................................................................................... 17
Menu Builder............................................................................................................................. 18
Database .................................................................................................................................... 20
Settings ...................................................................................................................................... 20
Configuration ................................................................................................................................ 21
Troubleshooting ............................................................................................................................ 22

About

“EStore” is a single vendor ecommerce script where you can add products, categories and much
more. EStore is built on top of the Laravel PHP framework. It is also built using the Laravel
Voyager Admin as the back-end of the site. Be sure to check out the demo to learn more.

You can find about laravel and voyager links below:

  Laravel
 Voyager

Next, let’s learn about some of the system requirements you will need in order to install the
script.

Requirements

EStore was built using Laravel 7.0, this means that the same system requirements needed for
EStore are the same as the system requirements for Laravel 7.0.

 PHP >= 7.2.5

 BCMath PHP Extension
 Ctype PHP Extension
 Fileinfo PHP extension
 JSON PHP Extension
 Mbstring PHP Extension
 OpenSSL PHP Extension
 PDO PHP Extension
 Tokenizer PHP Extension
 XML PHP Extension

To learn more about the system requirements needed to run a Laravel 7.0 script checkout the
following Server Requirements

Next, we’ll get started by learning how you can download the latest version of the script.

Getting Started

EStore is an easy to use PHP script. We will guide you how to use it without any issues. So, let’s
get started.

Installation

After downloading the script you will need to unzip the estore.zip file. You will see files
inside estore folder like one for documentation, one for database, one for hosting and another is
the main file.

Next follow the steps mentioned below.

Installation guide
 If you already have an empty database, a database username and password, you can skip
the step.

1. Create a new MySQL database.

2. Create a new MySQL username and password.
3. Assign full privileges to your database username.

Useful resources
cPanel - MySQL Database Wizard

Plesk - Website databases

 Import data from database.sql (it's located in the database file).

 Create .env from .env.example.

Next, you need to change the following things.

APP_URL Your application URL

DB_CONNECTION Database connection type. Default one is (mysql).
DB_HOST Database host ip. Default one is (127.0.0.1).
DB_PORT Database port number. Default one is (3306).
DB_DATABASE Name of your newly created database.
DB_USERNAME Name of your database user name.
DB_PASSWORD your database password

App Name Name of the application. You can give it any name.
App Envrionment For the server-side installation, choose the Production mode.
App Debug By clicking the true, all the errors would be shown
By clicking the false, no errors would be shown.(Recommended)
App Log Level App Log system. Keep the selected one.

Then you need to change the following things. Give correct information of your mail
configuration. Set your mail type, host, port, username, password, encryption type and
from address.

MAIL_MAILER=smtp

MAIL_HOST=smtp.mailtrap.io

MAIL_PORT=2525
 MAIL_USERNAME=your_username

MAIL_PASSWORD=your_password

MAIL_ENCRYPTION=null

[email protected]

Add the 2 lines at the end of the file

DISQUS_ENABLED=true
DISQUS_USERNAME=your_website_shortname
Replace your_website_shortname with your actual website shortname. Please refer to
this article to get your website shortname.

For payments add the following lines

(for stripe)
STRIPE_KEY= your stripe secret
STRIPE_PUBLISHABLE=stripe publish key

(for paypal)
PAYPAL_MODE=sandbox/live

PAYPAL_SANDBOX_API_USERNAME= user name

PAYPAL_SANDBOX_API_PASSWORD=password
PAYPAL_SANDBOX_API_SECRET=secret
PAYPAL_CURRENCY= currency code

PAYPAL_LIVE_API_USERNAME= user name

PAYPAL_LIVE_API_PASSWORD= password
PAYPAL_LIVE_API_SECRET= secret

(for cart values)

SHOPPING_FORMAT_VALUES= true
SHOPPING_DECIMALS=2
SHOPPING_THOUSANDS_SEP=''

 Upload all files that are located in your main file into on the web root folder of your
domain. This folder is generally called public_html, html, or example.com, but
depending on your server's configuration, it might be named differently.

** On some operating systems, the dot files are hidden by default. Before starting to
upload the files, please make sure your file explorer has the option to view hidden files
turned on.
 Useful resources

cPanel - File Manager

Plesk - Uploading content with File Manager

 Configure your web server's document / web root to point to the public directory of the
software. For example, if you've uploaded the software in example.com folder, your web
directory should be changed to example.com/public folder.

Useful resources

Point web root to public

 Open Browser with link URL: http://yourdomain.com/install (replace

yourdmoain.com with your original domain name) then Follow the next instructions to
install the script. After opening the link you will get the install page like the below
screenshot.

Click check requirements.

 The below mentioned are the dependencies or extensions for the server that are
essential components for installation. All the green checks would ensure the
 presence of all the above-mentioned dependencies. In case, if the system
doesn’t have any of these dependencies already installed, a red cross mark
would appear in the corresponding column of the missing component. So make
sure to install all the dependencies and extensions to ensure the smooth running
and installation of the app.

If all the requirements are green checks then click Check Permissions button and go to
next step.

 In this step, you need to grant the directed permissions respectively for instance.
Set the access permissions (CHMOD) to 775 to the following files and folders:

 bootstrap/cache/
 storage/framework/
 storage/logs/

Useful resources
cPanel - Update file or folder permissions

Plesk - Setting file and directory access permissions

 If all the permission goes green, click on Configure Environment.

 Now you will see a window of Environment Settings. Click on Classic Text Editor.
 Now you will see a Classic Environment Editor. As we have already set the .env file
correctly, we do not need to change things here. So, click on save and install.
 After that, you will see installation Finished.
 *** If you messed up something, just go to your storage folder and delete file named
‘installed’ and run the installation again.

 Go to example.com/admin and

Use [email protected] and password: password. You will see a warning message to fix
symlink. Click fix and it will create symlink.

Default Login

After successfully installing the script you may want to login using the default admin account
to add some posts or pages to your site.

As an admin you can login to the site in the location:

Login Through the Back-end

You may login through the typical back-end of your site by visiting site.com/admin
And you’ll see the default login screen in front of you.

You can now login using the following Admin Login credentials:

email: [email protected]
password: password

You will probably wish to change your login credentials for your admin user. You can easily do
this by visiting site.com/edit_profile after you are logged in and you can update your Name,
Email, and Password.

Next, let’s move on to learning more about the admin dashboard.

Admin Dashboard

After you have logged in with the admin user you can then visit your site at site.com/admin
and you will find yourself in the Admin Dashboard

To the left is your main navigation where you can visit the following sections respectively.

 Dashboard
 Orders
 Products
 Categories
 Posts
 Pages
 Users
 Roles
 Media
 Menu Builder
 Database
 Settings
Dashboard

The Dashboard is where you will find basic information about your website including how many
users, pages and posts are on your site.

You can also view Analytics data if you add your Google Analytics information into your Site
settings. You can read more about how to do this here https://webman.io/blog/post/setup-google-
analytics-for-laravel-voyager

Products
The products section is where you can add, edit, delete different products.

Orders

The orders section is where you can add, edit, delete different orders.

Categories
In the categories section you can view all the current categories that are available. You can edit
the existing categories or delete the existing categories. Additionally, you can add your own
category.

Note: by adding a new category this does not automatically mean it will be added to the menu.
You will need to add this item to the menu separately. We will go over the Menu Builder further
on down the documentation.

Posts
In addition to adding Products to your new site you may also wish to add posts. This is very
similar to the way the products works. You can add/edit/delete products or you can Add a new
post.

Pages
Instead of adding a post you may wish to add, edit, or delete pages for certain sections such as an
about page or a contact page.

Users

In the users section you can view all the current users on your website. Additionally you will see
your admin user in this list. You can edit or delete any user from your site from the user section.
Roles

Each user has a role that allows them access to different sections of the apps. Currently in EStore
there are 2 roles which is a Normal User and an Admin User. A Normal User only has access to
all the front-end sections of your site; whereas the Admin User has access to both the front-end
and the back-end admin of the website.

Media Manager
Using the media manager you can easily manage any images or content that gets added to your
site. You may wish to rename or delete files and folders as well as add new content through the
media manager.

Warning: Be careful when deleting content because if you delete images that are linked to
products or posts they may show a broken image when that product or post is being viewed.

Menu Builder
Using the Menu builder you can create multiple menus to use throughout your site. There are
currently 4 menus that you will see.

 admin is the back-end menu that you currently see in your admin.
 header_menu is the front-end side menu on the category page.
 footer_menu is the front-end menu in the footer of your site.

When you click on the green Builder button you will be taken to the builder page for that menu.

In the Menu Builder section you can drag and drop current menu items to the position you would
like them to appear. You can also Add, Edit, or Delete menu items from that particular menu.
Database

In the database section of the site you can see all the tables associated with your application.

If you are not a developer it might be a good idea to leave this section alone unless you know
what you are doing.

In the database section you can also change the way your Browse, Read, Edit, Add, and Delete
functionality works throughout your site. You can learn more about the BREAD system here
https://the-control-group.github.io/voyager/docs/

Settings
The settings section allows you to customize different aspects of your site including the logo and
themes. Continue reading more below to learn how to configure and customize your site.

Configuration

There are many configurations or customizations you can change on your site. To change these
customizations you will want to visit yoursite.com/admin/settings and you will be able to
modify the current configurations.

Site Title This is the title of your site and this will show up in the header title of your homepage.

Site Description This is a description of your site and this will be used as the meta description
for your site homepage.

Site Logo You can upload your own logo to show up on the front-end of the site. For best results
upload a PNG image with the dimensions around 648x200 pixels. This will gaurantee that your
logo will look nice on HD devices.

Admin Description This is the description that will be shown on the admin login screen.

Admin Background Image This is the background image that will be shown on the admin login
screen.

Admin Title This is the title that will be used in the top left of your Admin Panel when the menu
is expanded. It will also be used on the admin login page.

Admin Loader You may wish to customize your admin with a custom loader image. You can
upload a new image to use as your spinning loader.
Admin Icon Image The admin icon image is the image that you see on your admin login page
and you also see at the top left of your admin dashboard.

Social Here you can add your social profiles.

Contact Here you can add your contact info.

Footer Description Here you can add description used in footer.

Footer Image Here you can add footer image.

Troubleshooting

If you are having any troubles with your site please try the following commands to see if it will
resolve any of them.

Make sure your storage link is linked correctly If you are not seeing images on your site you
may need to check the APP_URL in your .env file.

Make sure your system meets the minimum requirements You can check the system
requirements above against the software you have on your server.

Still having an issue or a problem? Then contact at [email protected]