Welcome to Pixel

Welcome to the Pixel Documentation. In this file you will find the requirements required to install the script, instructions on how to install the script, instructions on how to configure different parts of the script, and troubleshooting tips.

So, lets begins…

## Requirements

The requirements for this script are pretty minimal, but each requirements must be installed for the script to be fully functional.

- PHP >= 5.5.9
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- Tokenizer PHP Extension

Most of these requirements are installed on most modern hosting plans.

## Installation

Installing the script is very simple. Additionally be sure to checkout the getting started video where you will walk through step-by-step on the installation process. Follow these basic steps to get the Pixel script setup and installed on your server.

- Upload all the files from the pixel.zip contents to the root folder of your website location. The files you upload to your root folder will look like the following: (note if you are installing the developer version there are a few more steps required, please see below for instructions on installing the dev version)

Pixel Files

- After all the files have been uploaded to your server, you’ll need to create a new database for your script.
- Next you’ll need to add those new database credentials by opening the .env file and adding your database host, name, username, and password, the file you will edit look like the following and you’ll be replacing localhost, database, username, and password accordingly:

    DB_HOST=localhost
    DB_DATABASE=database
    DB_USERNAME=username
    DB_PASSWORD=password

- After adding your database credentials be sure to save the file and then visit yoursite.com and you should see the following install screen in your browser (if not all the requirements pass you may have to contact your hosting provider to make sure your server meets all the requirements):

Pixel Installer

- Finally, Click ‘Visit Your New Site’ button and you should see your new Pixel Download site in front of you:

Pixel Site

- And just as easy as that you’ve just setup your new Media Download site. (!!! IMPORTANT !!!, make sure to remove the install.php file from your server, this is a security risk if you do not remove this file)

#### Installing the Developer Version

First off, lets explain why we have a developer version…

Pixel is built using the Laravel framework and we have modified the default folder structure of Laravel to make the app easier to install and upgrade.

If you plan to use this codebase and want to keep the original Laravel structure so that way it’s easier for you to build on top of and add a lot of new functionality, you may want to use the developer version. The developer version will not be easy to upgrade when future versions are released on Codecanyon.

Ok, now to install the developer version you will unzip the ‘pixel-developer-version.zip’ file and upload the files to your root server. Note, you will need to point your domain to the ‘public’ folder inside the app. This is common for every Laravel app.

Next, you will need to open up your app in terminal or a shell command and run ‘composer install’ from the root directory.

After composer has successfully completed, you will need to create a new database and add your database credentials to your .env file similar to what we have done in the previous example.

Next visit yoursite.com/install.php and if all goes well you will see all steps pass and you can click on the ‘Visit Your New Site’ button similar to the image above. Be sure to remove the public/install.php file from your server. And now your developer version of Pixel app will be successfully installed!

## Upgrading

    Note: The upgrade procedure does not pertain to the non-developer version.

Upgrading the script is very simple. To upgrade to the latest version of the script, simply replace the ‘application’ folder with the new ‘application’ folder. Then make sure to run yoursite.com/upgrade to install any additional database tables and you’ll be upgraded to the latest version.

To upgrade the developer version you’re going to have to do a file compare between the differences and make the changes to your code accordingly. As stated above it will not be as easy to upgrade the developer version; however, if there are new features built-in this may be as simple as copying over a new controller or a few routes.

## Admin Login

After successfully installing the script you will be able to login with the default admin credentials:

email: admin@admin.com

password: password

To login you will click the login button in the footer.

Login button

After logging in successfully you can click on the admin button in the footer, which will bring you to your admin dashboard:

Admin dashboard

In order to set your own admin login credentials you will click on the settings button and then in the settings page you will update your admin email and password.

Admin login info

Then click ‘update’ and your new admin credentials will be saved.

#### Reset your Admin Login

If you happen to lose your login information for your admin user you can simply reset the admin login to defaults by going through the following steps.

- Open up your .env file and change: `RESET_ADMIN=false` to `RESET_ADMIN=true`
- Then visit yoursite.com/reset_admin and you will get a message that says your admin credentials have been restored to default.
- Then you can login with the default email/password from above and navigate to your admin settings page to change your email and password to a desired login.
- Finally, be sure to change your .env file back from `RESET_ADMIN=true` to `RESET_ADMIN=false`.

## Admin & Configurations

To visit the admin section of your site you must login and then click on the admin link in the footer.

### Admin Dashboard

Upon visiting your admin section of your site you will be on the admin dashboard:

Admin dashboard

On the dashboard you can navigate to the multiple different admin sections including Media (add/edit/delete downloads), Categories (add/edit/delete categories), Site Settings (change/configure your site settings), and your About Page (add the content to be shown on your about page).

We will go into brief description of these sections below:

### Media/Downloads

Admin Media/Downloads

In this section you can add edit and delete media for your site. Be sure to leave a good description for your download as this helps with SEO for your site.

### Categories

Admin Categories

Add Categories for your downloads. You can also add child categories and specify their order.

### Site Settings

Admin Settings

This is where you can change the name of your site and description. You can also change the logo and favicon for your site.

You’ll want to be sure to update your admin login email and password in this section as well.

Add your social networks, advertisements, and so much more.

### About

Admin About

Use the WYSIWYG editor to add your website about section. You can format your about page to tell your users all about what your website offers.

### Customizations

If you want to add your own custom CSS, be sure to enter it in the /content/custom.css file or for the developer version it will be in your the /public/content/custom.css :)