https://github.com/kossa/laralte2
LaraLTE2, Laravel PHP Framework with AdminLTE2
https://github.com/kossa/laralte2
admin adminlte apidoc laravel php
Last synced: about 2 months ago
JSON representation
LaraLTE2, Laravel PHP Framework with AdminLTE2
- Host: GitHub
- URL: https://github.com/kossa/laralte2
- Owner: kossa
- Archived: true
- Created: 2016-06-02T21:51:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-01T06:27:55.000Z (about 8 years ago)
- Last Synced: 2024-06-26T13:32:05.208Z (over 1 year ago)
- Topics: admin, adminlte, apidoc, laravel, php
- Language: JavaScript
- Homepage: http://laralte2.bel4.com/admin
- Size: 9.85 MB
- Stars: 26
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-laravel - LaraLTE2 - Laravel PHP Framework with [AdminLTE2](https://almsaeedstudio.com/AdminLTE) and other packages and JavaScript tools. \[06/04/2016\] (Packages / Boilerplate/Customized Configurations)
- awesome-laravel - LaraLTE2 - Laravel PHP Framework with [AdminLTE2](https://almsaeedstudio.com/AdminLTE) and other packages and JavaScript tools. \[06/04/2016\] (Packages / Boilerplate/Customized Configurations)
README
# LaraLTE2
**_[Laravel](https://laravel.com/) PHP Framework with [AdminLTE2](https://almsaeedstudio.com/AdminLTE)_**
Whenever I start a new Laravel project, I do the same thing; Install packages, download Javascript plugins...etc.
This repository helps me bootstrap all of that.
**Note:** ***if you want to use Laravel [5.2](https://github.com/kossa/laralte2/tree/5.2), [5.3](https://github.com/kossa/laralte2/tree/5.3), [5.4](https://github.com/kossa/laralte2/tree/5.4) please checkout to branch***
## Setup:
All you need is to run these commands:
```bash
git clone https://github.com/kossa/laralte2.git
cd laralte2
composer install # Install backend dependencies
sudo chmod 777 storage/ -R # Chmod Storage
cp .env.example .env # Update database credentials configuration
php artisan key:generate # Generate new keys for Laravel
php artisan migrate:refresh --seed # Run migration and seed users and categories for testing
yarn install # Install node dependencies
npm run production # To compile assets for prod
```
## Demo:
- Online demo: Can be found at [laralte2.bel4.com/admin](http://laralte2.bel4.com/admin)
- Local demo:
`php artisan serve # Check installation (optional)`
Open browser at [localhost:8000/admin](http://localhost:8000/admin)
**Note:**
Username: test@example.com
Password: 123456
> All the data are reset each 30mn ;)
> **please d'ont forget to remove [this](https://github.com/kossa/laralte2/blob/master/app/Console/Kernel.php#L27-L28) function in your app**
***
## Included Packages:
#### Laravel (php):
* [Laravel Framework](https://github.com/laravel/laravel/) (5.4.*)
* [Forms & HTML](https://github.com/laravelcollective/html) : for forms
* [Laravel Debugbar](https://github.com/barryvdh/laravel-debugbar) : for debugging
* [Intervention Image](https://github.com/intervention/image) : image handling and manipulation
* [Guzzle](https://github.com/guzzle/guzzle) : PHP HTTP client
* [Laravel RESTful API format](https://github.com/teepluss/laravel-restable) : To create Rest API
* [Redis](https://github.com/nrk/predis.git) : for chache
#### JS plugins:
LaraLTE2 uses :
* [Laravel Mix](laravel-mix)
* [AdminLTE](https://github.com/almasaeed2010/AdminLTE)
* [AdminLTE-RTL](https://github.com/morteza/bootstrap-rtl) for RTL support
* [ApiDocs](https://github.com/apidoc/apidoc)
* [Ionicons](https://github.com/driftyco/ionicons)
* [bootstrap](https://github.com/twbs/bootstrap)
* [chosen](https://github.com/harvesthq/bower-chosen)
* [ckeditor Full](https://github.com/ckeditor/ckeditor-releases)
* [datatables + plugins](https://github.com/DataTables/DataTables)
* [datetimepicker](https://github.com/xdan/datetimepicker)
* [font-awesome](https://github.com/FortAwesome/Font-Awesome)
* [jquery](https://github.com/jquery/jquery)
* [sweetalert2](https://github.com/limonte/sweetalert2)
* [iCheck](https://github.com/fronteed/iCheck)
* [Axios](https://github.com/mzabriskie/axios)
* [VueJs](http://vuejs.org/)
* [Turbolinks](https://github.com/turbolinks/turbolinks)
## Page size optimization:
- Using [Laravel Mix](http://laravel.com/docs/master/mix), all CSS and JS are in minified to one file each.
- LaraLTE2 leverages browser caching, using `.htaccess` file from [html5-boilerplate](https://github.com/h5bp/html5-boilerplate)
- GZip compression is activated by default(APP_DEBUG=false => only onfile for js, and one file for css).
- `admin-HASH.css`: 63.9KB with gzip (376.5Kb without)
- `admin-HASH.js` : 99KB with gzip (318.9Kb without)
*__Note:__ If you're using Nginx check: [server-configs-nginx](https://github.com/h5bp/server-configs-nginx)*
### REST API
As you may see in included packages, I used [ApiDocs](http://apidocjs.com/) to document all routes in `api/v1` and controllers in `Api` namespace.
You can check the docs at [laralte2.bel4.com/api](http://laralte2.bel4.com/api/)
*__Note:__ The API is protected by token, so when you send a request you should include `APP-TOKEN` in the header, this value will be compared to `APP_TOKEN` in `.env` file check [this middleware](https://github.com/kossa/laralte2/blob/master/app/Http/Middleware/ApiToken.php#L21)*
#FAQ
#### Create new CRUD
Creating CRUD in your application is the job you do most. Let's create Post CRUD:
* Add new migration and model : `php artisan make:model Post -m`
* Open migration file and add your columns
* Create PostsController : `php artisan make:controller`. fill your resource (you can use CategoriesController with some changes) or, if you are a lazy developer like me, use a [snippet](https://github.com/kossa/st-snippets/blob/master/kossa_php/Laravel/lcontroller.sublime-snippet) and make only 2 changes
* Duplicate `resource/views/admin/categories` folder to `posts`, make changes in `index.php`, `create.blade.php`, `edit.blade.php`
#### Move Image and file ?
To move images im using a [helper](https://github.com/kossa/laralte2/blob/master/app/Http/helpers.php#L4) function based on [intervention/image](https://github.com/intervention/image) and [variables.php](https://github.com/kossa/laralte2/blob/master/config/variables.php#L15)
you can check full example in [User.php](https://github.com/kossa/laralte2/blob/master/app/User.php#L73)
#### Do you need RTL support ?
* Copy/paste "rtl-dependencies" into "dependencies" [section](https://github.com/kossa/laralte2/blob/master/package.json#L33-L34)
* Change all `pull-right` to `pull-left` in [default](https://github.com/kossa/laralte2/blob/master/resources/views/admin/default.blade.php) file and vise versa
* Uncomment this [line](https://github.com/kossa/laralte2/blob/master/webpack.mix.js#L26) in webpack.mix.js
* Run: `yarn upgrade && npm run dev`, you're ready to go ;)
#### Create new REST API
Rest Controllers are in the `App\Http\Controllers\Api` namespace.
* Create new controller that extends `ApiController` class
* Add your route in `api/v1` route group
* Add documentation block ([documentation](http://apidocjs.com/#example-full))
* Install ApiDoc via npm, run: `npm install apidoc -g` (only first time)
* Run this command : `apidoc -i app/Http/Controllers/Api/ -o public/api/ -t resources/apiTemplate/`
* That's all :)
#### Do you have question ?
Not hesitate, [open](https://github.com/kossa/laralte2/issues/new) new issue ;)