laravel-bootstrap-adminlte-starter-kit

Template for websites with basic functionality. It is based on next ideas:

• have common features already integrated and configured (tests,gulp,bower etc)
• simplify updates (via git merge from this project)
• extensive use of .env config (slightly more then original Laravel)
• 'make' based macro-tool for often used commands 

Home : https://gitlab.com/oprudkyi/laravel-bootstrap-adminlte-starter-kit/
Mirror: https://github.com/oprudkyi/laravel-bootstrap-adminlte-starter-kit 

Introduction

Just base functionality for other projects

Project includes already preconfigured resources:

• Laravel 5.3
  
• AdminLte template Laravel Integration
• jrean/laravel-user-verification
• oprudkyi/laravel-mail-logger
• Front-End:
  
  • Bower
  • Bootstrap
  • Font Awesome
  • jQuery
  • DataTables
  • Moment.js
  • Bootstrap 3 Date/Time Picker
  • js-error-alert
• Testing (preconfigured for unit,functional and acceptance tests):
  
  • Codeception - BDD-styled PHP testing framework atop of PHPUnit
  • Codeception/PhpBuiltinServer - Codeception extension to start and stop PHP built-in web server for your tests.
  • Phantoman - The Codeception extension for automatically starting and stopping PhantomJS when running tests.
  • codeception-events-scripting - The Codeception extension for automatically running shell scripts on Codeception events.
  • MailCatcher - catches mails and provides API for testing
  • Codeception MailCatcher Module
  • PhantomJS - a headless WebKit, used for acceptance testing
  • Setup Test DB Command for Laravel

Creation of new site based on starter kit

#clone original repository
git clone git@gitlab.com:oprudkyi/laravel-bootstrap-adminlte-starter-kit.git my_project

#cd to project
cd my_project

#delete origin
git remote rm origin

#use your new repository as main source 
git remote add origin git@gitlab.com:oprudkyi/web-site.git

#keep original source for updates
git remote add starter-kit git@gitlab.com:oprudkyi/laravel-bootstrap-adminlte-starter-kit.git

#push to your repository
git push -u origin master

 

Keeping your site in sync with starter kit

git fetch starter-kit
git merge starter-kit/master
git push

or

make merge-starterkit
git push

 

Installation

If you are building from the first time out of the source repository, you will need to generate the configure scripts. From the top directory, do:

./bootstrap.sh

Once the configure scripts are generated, 'make' system can be configured. From the top directory, do:

./configure

Run ./configure --help to see other configuration options
Install configured dependencies - tools like composer/bower and components as defined in composer.json, bower.json, package.json :

make download-dependencies

 

Testing

There are a large number of tests that can all be run from the top-level directory.

      make -k check
      make -k check-functional
      make -k check-acceptance

This will make all of the libraries (as necessary), and run through the unit tests defined in each of the client libraries. If a single language fails, the make check will continue on and provide a synopsis at the end.

 

Boostraping development environment

cp .env.example .env
vim .env

#for sqlite db
touch storage/database/play.sqlite
./artisan migrate

#generate key
./artisan key:generate -v

 

Update dependencies

make update-downloaded-dependencies

or

make update-downloaded-dependencies-production

it will search for updated packages for composer/npm/bower and install them as well will update lock/json files

 

Mailcatcher integration

Mailcatcher is configured in the .env.example for port 1025, tests use different port (11031) so tests can be run while development instance of maicatcher is running
Run:

make run-mailcatcher

Stop:

make stop-mailcatcher

Mailcatcher web gui available via http://127.0.0.1:1080/

 

Javascript/Css assets

Intergration is based on Laravel Elixir and Bower as package system (packages installed into vendor/bower_components).
To call bower use something like

node_modules/.bin/bower install "eonasdan-bootstrap-datetimepicker#latest" --save

or update current dependencies

node_modules/.bin/bower install

The building script is gulpfile.js. System is configured to generate single js file from all packages provided (as well single css file)
if you add/remove packages, you may also need to edit resources/assets/sass/app.scss as well for adding/removing css/scss/js
use 'make gulp' or 'make gulp-watch' to compile resources
custom css rules you can add to resources/assets/sass/starterkit/starter-kit-customize.scss it's applied after any other css, so it's possible to change any css behavior here

 

Manual Deployment Initialization

This isn't adivsed , just for info:

• First, clone your repository to production/staging server
• configure production environment

    ./bootstrap.sh
    ./configure --enable-tests=no
    make download-dependencies-production
    chmod 777 -R storage

• create db (in case of mysql)

sudo mysql 

CREATE DATABASE IF NOT EXISTS starterkit_db CHARSET=utf8;
CREATE USER 'starterkit_user'@'%' IDENTIFIED BY 'starterkit_password';
GRANT ALL PRIVILEGES ON starterkit_db.* TO 'starterkit_user'@'%';

• create env file

cp .env.example.production .env
vim .env

• create key

php artisan key:generate

• migrate db

php artisan migrate

• optimize app

make production-optimize

it will run next commands:

#clear cache
php artisan view:clear
php artisan config:clear
php artisan route:clear
php artisan clear-compiled

#optimize
composer dump-autoload --optimize


#caching 
php artisan cache:clear
php artisan config:cache
php artisan route:cache
php artisan optimize

#recompile js/css
gulp

 

Manual Deployment

git pull
make download-dependencies-production
php artisan migrate
make production-optimize