WrapByte logo WrapByte

Installation


Banner

Material Pro Admin is a popular open source WebApp template for admin dashboards and control panels. Material Pro Admin is fully responsive Laravel template, which is based on the CSS framework Bootstrap 4. It utilizes all of the Bootstrap components in its design and re-styles many commonly used plugins to create a consistent design that can be used as a user interface for backend applications. Material Pro is based on a modular design, which allows it to be easily customized and built upon. This documentation will guide you through installing the template and exploring the various components that are bundled with the template.

Pre-Requirements

As this is a Laravel template, please refer to Laravel Docs

You need on your machine:

  • PHP installed
  • Webserver, with one of the options:
  • MySQL for database, or SQLite extension on PHP (optional, or other of your preference)
  • Composer for downloading PHP dependencies
  • NodeJs For using NPM, on Javascript dependencies

Demo Project

If you want to just play with the demo, you can follow this steps:

Instructions

  1. Unzip the "Demo" project file
  2. Go your terminal/command shell, and go inside the unzipped project.
    Depending on your choice of webserver, you may have to place the folder in a specific location. Refer to its docs.
  3. Execute composer install
    This will install PHP dependencies as the saved composer.lock file.
  4. Copy the .env.example to .env file, to make the environment file
    Execute: cp .env.example .env
  5. Execute php artisan key:generate
  6. Execute php artisan serve
  7. Visit the website provided, you are ready to go.
    This step may vary, if you're using a tool for local webserver.

Starter Project

To install, and use the starter project, you can follow this steps:

Instructions

  1. Unzip the "Starter" project file
  2. Go your terminal/command shell, and go inside the unzipped project.
    Depending on your choice of webserver, you may have to place the folder in a specific location. Refer to its docs.
  3. Execute composer install
    This will install PHP dependencies as the saved composer.lock file.
  4. Copy the .env.example to .env file, to make the environment file
    Execute: cp .env.example .env
  5. Execute php artisan key:generate
  6. Execute php artisan serve
  7. Visit the website provided, you are ready to go.
    This step may vary, if you're using a tool for local webserver.
  8. Configure database, in .env file.
    Example, for MySQL, set the values for DB_DATABASE, DB_USERNAME and DB_PASSWORD
    If you don't want to setup database/service, you may use SQLite:
    • Create empty file: touch database/database.sqlite
    • Delete or comment with #, the all the DB_* keys, leaving only DB_CONNECTION=sqlite
  9. Run php artisan migrate --seed
    This will create the tables needed for the app to run, and fill some demo values.
  10. You may now visit the website.
  11. CSS and Javascript assets, are compiled using Laravel Mix
    So, to reflect changes on scss and/or js files, we must compile them.
  12. First, let's install the dependencies, as package.lock, running npm install
  13. You may now run npm run dev to compile for local usage, or npm run production (minified) for server usage.
    You may also want to refer to Laravel Mix Documentation for further usage.
    npm run watch for example, to keep running and watch for changes, re-compiling only affected files.
  14. You may now visit the website.

Inside an Existing Project

If you have and existing project and would like to just add the Monster Admin theme you should copy the necessary folders in to your project. So, the folders:

  • public/vendor
  • resources/vendor
  • resources/views
  • and webpack.mix.js file

Must be accordingly copied to your destination project.