@theme('path') directive with Blade. Otherwise its basically anything and everything Blade can do including any directives you wish to expand it with.
### Blade Directives
Grafite CMS has some custom directives added to Blade which allows you to include files from your theme easily, as well as other parts.
#### @theme('path.to.view')
You can always add the cms-frontend:: namespace to the @include('path') or instead use @theme('path').
#### @block('slug')
Create unique and elegant designs with block directives in your templates for pages and blogs.
!!! Warning
With the block blade directive you do not specify the module it needs to load, it determines that from the first string in the request URL.
It will default to page if no matching module name matches the URL. In the case of something like `events`, it expects the variable in the template
to be `$event`. It is wrapped in the `optional` method to protect the view from breaking the app.
#### @menu('slug')
Easily add menus to your views with the menu blade directive.
#### @modules(['modules-to-ignore'], 'link-class', 'list-item-class')
Generate links to modules automatically (Bootstrap 4 by default).
#### @widget('slug')
Add widgets to your views with the menu blade directive, just specify the SLUG.
#### @image('id', 'class')
Provides an image URL with an html tag and extra for adding a class
#### @image_link('ID')
Provides an image URL
#### @images('tag')
Images will be provided as an array, and if you skip the tag then the method will return all images, otherwise it follows the tagging.
#### @edit('module', 'id')
There is also the Grafite CMS Service which can be run inside your blade views. Its as simple as {{ Cms::method() }}
#### @markdown('content')
Convert your markdown blog or page entries into HTML.
#### @languages('link-class', 'list-item-class')
Generate links for each supported lanugage in your website
Helper Methods Available:
------
* menu('slug', 'optional-view-path')
* images('tag')
* widget('slug')
* editBtn('module', 'id')
### Pages and Blocks
There are some special features for pages which are not available for other parts of the site.
#### Blocks
Pages are special and can often require complex designs. If your application needs some of the more abstract designs you can still use Grafite CMS for page management by using the block system.
```php
{!! $page->block('main') !!}
```
or
```
{{ block('main') }}
```
By placing code like this in your template Grafite CMS will generate the `main` block if it does not exist yet. If it does and has content it will render the content. It's really that simple.
### Publishing
#### Command
```
php artisan theme:publish {name}
```
The Grafite CMS theme publisher will publish the public directory only. If you want to integrate assets you need to do so using your `webpack` or `gulp` file, pending on which setup you use.
| Laravel Verison | Asset builder |
| --- | --- |
| 5.4+ | `webpack.mix.js` |
| 5.3 | `gulpfile.js` |
Basic Theme (top tier)
------
* assets
* blog
* events
* faqs
* gallery
* layout
* pages
* partials
* public
* img
### Symlink
#### Command
```
php artisan theme:link {name}
```
The Grafite CMS theme link tool will create a symlink between your public folder and a folder in your public directory called `theme`.
This can make it easier to manage assets within a theme.
| Laravel Verison | Asset builder |
| --- | --- |
| 5.4+ | `webpack.mix.js` |
| 5.3 | `gulpfile.js` |
Basic Theme (top tier)
------
* assets
* blog
* events
* faqs
* gallery
* layout
* pages
* partials
* public -> `{app_directory}/public/theme`
* img
### Modules
Grafite CMS comes with a handful of modules for handling a basic application/website including: Images, Files, Blog, Pages, Faqs, etc.
Below you will find a full listing of the modules that come pre-packaged with Grafite CMS.
In order to create your own Modules and ensure that they are loaded you MUST add `"Cms\\": "cms/"` to the PSR-4 group in your `composer.json` file.
Pre-packaged Modules
------
* Blog
* Pages
* Menus
* Widgets
* Faqs
* Images
* Files
* Events
You have the freedom to make any modules you want. You can use the `artisan module:make` or the `artisan module:crud` to generate them and then `artisan module:publish` to publish their contents.
### Assets
Grafite CMS modules have an `Assets` directory which is intended to contain all your JS and SASS or CSS. In order to load the Assets in your Module, you can use the `Cms` facade.
Grafite CMS comes with a Minify package so you can easily load your modules assets with calls like below. You don't have to set the content-type.
But pending on what you're loading you may want to override what the Cms service determines is the content-type.
So if you want to load your css file in your Sample module's Assets you could do the following:
`Assets/css/styles.css` is the file we're grabbing.
```
```
Or we can load some JavaScript, and yes jQuery is already inside Grafite CMS.
`Assets/js/module.js` is the file we're grabbing.
```
```
### Composer
So now you've made a CMS module and it's serving your application well, but now you've decided that it would make more sense for it to be a composer package, that you can run inside any app for easier maintenance. This also gives you far more freedom to decide how you wish to integrate the module into your app.
```
module:composer {name} {namespace}
```
This will generate a composer file, as well set the namespace of your module to a new package namespace.
### Config
The configs are autoloaded and are added to the cms config.
```
config('cms.modules.sample') // would retrieve the sample modules internal config.php contents
```
If you want to access a config that is customizable for your module you can publish one:
```
php artisan vendor:publish
```
### CRUD
Grafite CMS can generate custom CRUD modules for your application giving it all the power you want as fast as possble. Simply run the command: `php artisan module:crud` and discover the many hidden powers inside the Grafite CMS.
The CRUD generator will produce a module with basic unit tests started. You would then need to setup your migrations etc, and then publish the module to your app. Check out the publishing for more details.
#### Forms
You can use the Form Maker tool which is provided by [Grafite Builder](https://github.com/GrafiteInc/Builder)
#### Redactor
You can utilize redactor (the WYSIWYG) in your CRUD by adding `.redactor` to any textarea class.
#### Images and Files:
Inside the redactor instance you can easily add images and files which you have uploaded to Grafite CMS. Its as easy as clicking them to have them added to the entry.
#### Front-end/ Theme
When you generate a module the system will also generate a front-end or theme component which is kept in the `Publishes` directory. The is the portion of code that your visitors will see. You will need to publish this code using the `php artisan module:publish {name}` command.
Provided you leave the module inside the `cms/modules` directory. However, you can also make your module into a composer package.
### Files & Images
Grafite CMS is always concerned with security of what you provide, the potential open doors in your website/ app. As such, the Files which are uploaded to the CMS are locked outside of the public access points.
*What does this mean?*
This means that when you're website is providing these to visitors they are actually getting them through an API access point. This is done to ensure that the files do not reveal thier location. This means that no webscrappers can crawl your directories and take off files they shouldn't be, including files that have yet to be released.
#### Storage Location
In the config you can set the storage location for your file uploads. This can be either S3 or local. To get S3 to work correctly you need to configure Laravel as you would with S3. Grafite CMS will take it from there. So simply add your details to the config and it should work. The CMS loads all the third-party packages you will need.
### Make
Grafite CMS has a powerful CRUD builder. But lets say you want to have a custom module that integrates with another service or doesn't involve a CRUD at all.
Then the `php artisan module:make` command will be your best tool. It will create a minimum viable module with a very basic admin layer and client layer which you can customize as you see fit.
#### Redactor
You can utilize redactor in your module by adding `.redactor` to any textarea class.
#### Images and Files:
Inside the redactor instance you can easily add images and files which you have uploaded to the CMS. Its as easy as clicking them to have them added to the entry.
#### Front-end/ Theme
When you generate a module the system will also generate a front-end or theme component which is kept in the `Publishes` directory. The is the portion of code that your visitors will see. You will need to publish this code using the `php artisan module:publish {name}` command.
### Publish
All custom modules will need to have their `Publishes` folder published in order to have their code added to you app. We've wrapped this into one simple command:
```
php artisan module:publish
```
Running this will place the files in the matching folders in your app. So if you want to have files put in migrations make sure your `Publishes` folder has a migration file in a directory like this:
```
Publishes/database/migrations/migration_file.php
```
If you switch themes in Grafite CMS you will need to republish your module. The views are added directly into the themes.
## License
Grafite CMS is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
## Redactor License
Grafite has an OEM licence for the use of Redactor in the Grafite CMS package.
You are fully welcome to use Grafite CMS package and incorporate it into any apps you build, you are permitted to offer those apps as SaaS or other products.
However, you are not entitle to strip out parts of Redactor and resell them, please see this [license](https://imperavi.com/redactor/license/) for more information
### Bug Reporting and Feature Requests
Please add as many details as possible regarding submission of issues and feature requests
### Disclaimer
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: changelog.md
================================================
# Change Log - Grafite CMS
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
----
## [v3.3.0] - 2019-09-04
### Added
- Compatible with Laravel 5.7 and up
## [v3.2.2] - 2018-10-25
### Added
- Ability to delete hero images
### Changed
- Module migrations
### Fixed
- npm security audit
- Mobile UI fixes
- Menu and link fixes
## [v3.2.1] - 2018-09-14
### Fixed
- Issue with middleware not being added via simple setup
## [v3.2.0] - 2018-09-06
### Changed
- Laravel 5.7 support
## [v3.1.9] - 2018-09-06
### Changed
- Added info on Redactor to readme
### Fixed
- Issue with file and image upload
## [v3.1.8] - 2018-09-05
### Fixed
- Issue with file and image uploads
- and bulk photo delete
## [v3.1.7] - 2018-09-03
### Added
- New Promotions component
- All new Redactor 3 integration
- Google Analytics support upgrade
### Changed
- Improved API component
- Improved module templates
- Link page connection improvements
### Fixed
- Issues with languages
- Issues with UI
- Issues with images
## [v3.1.6] - 2018-08-01
### Changed
- Improved the urls of published files
### Fixed
- Issue with CMS modules
- Issues with translations
- Issue with notifications
## [v3.1.5] - 2018-07-03
### Changed
- Added optional class to menu blade directive
### Fixed
- Issue with menus
- Issue with BaseService files
## [v3.1.4] - 2018-06-24
### Changed
- Minor code cleanup
### Fixed
- Issue with notifications
## [v3.1.3] - 2018-06-18
### Fixed
- Minor issues with dark theme
- Test fixes
## [v3.1.2] - 2018-06-18
### Added
- Translatable menu links
- New theme symlink command
### Fixed
- Side panel spacing
- Translation improvements
## [v3.1.1] - 2018-04-19
### Fixed
- Issue with file and image saving
- Improved language switching links
## [v3.1.0] - 2018-04-12
### Added
- RSS feed
- Module Block support
- Site Map
- Block directive support for Blogs
### Fixed
- Routes
- Success Messages
- Table CMS prefixes
- Link validation
- Module searches
## [v3.0.1] - 2018-03-23
### Fixed
- Minor style fixes
## [v3.0.0] - 2018-03-23
### Changed
- Bootstrap upgrade
- Overhaul of codebase
- General Improvements
- Laravel 5.6 compatibility upgrade
## [v2.4.6] - 2018-02-21
### Fixed
- Issue with payloads
## [v2.4.5] - 2018-02-21
### Added
- Cloudfront support
### Fixed
- Security concern
- Language issue
- Date issue
## [v2.4.4] - 2017-10-25
### Added
- WYSIWYG icon feature
## [v2.4.3] - 2017-09-21
### Changed
- Removed logout link from basic theme
### Fixed
- Fixed issue with setup command
- Corrected a bad route definition
## [v2.4.2] - 2017-09-19
### Fixed
- Issue with blog tags
## [v2.4.1] - 2017-09-18
### Added
- published_at as dates
- enhanced the admin dashboard
### Changed
- Code clean up
## [v2.4.0] - 2017-09-15
### Changed
- Now supporting Laravel 5.5
## [v2.3.32] - 2017-09-15
### Changed
- Improved loading time of images drastically
### Fixed
- Refactored the images as assets
## [v2.3.31] - 2017-08-11
### Fixed
- Further image improvments
## [v2.3.30] - 2017-08-10
### Fixed
- Minor issues with Images
## [v2.3.29] - 2017-07-10
### Fixed
- Minor issue with Quazar tests
## [v2.3.28] - 2017-07-10
### Added
- New entity relations for images
- Bulk image deleting
## [v2.3.27] - 2017-07-06
### Fixed
- Fixes issue with JS which broke the image upload
## [v2.3.26] - 2017-07-03
### Fixed
- Issue with blog history view
## [v2.3.25] - 2017-06-22
### Added
- Sortable menus
### Fixed
- Issue with images
## [v2.3.24] - 2017-06-03
### Fixed
- Corrected internal API issue
## [v2.3.23] - 2017-06-03
### Added
- Backend route prefix default: cabin
### Changed
- Refactored asset caching and local detection
### Fixed
- Issue with widgets and translations
## [v2.3.22] - 2017-05-31
### Changed
- Refactored the asset system
### Fixed
- Updates to the generated tests
## [v2.3.21] - 2017-05-18
### Fixed
- Minor issues with images and S3
## [v2.3.20] - 2017-05-15
### Changed
- Switched to admin@example.org
## [v2.3.19] - 2017-05-07
### Fixed
- Fixes an issue with the 24 hour clock in Repositories
## [v2.3.18] - 2017-05-04
### Fixed
- Resolved issue with inaccurate published_at regarding timezones
## [v2.3.17] - 2017-05-03
### Added
- Dashboard view for admin
- Admin dashboard link
### Fixed
- Better feedback in image/file insert
- Menu and page block fixes
- Fixes for windows directories
- Language and block related fixes
- Fillable fixes
## [v2.3.16] - 2017-04-26
### Added
- Modules now can be ignored by the menu directive via config or expression
### Changed
- Allows fillables to be modified for default modules
## [v2.3.15] - 2017-04-11
### Changed
- Fillable fields for the models
## [v2.3.14] - 2017-04-10
### Changed
- Improved the structure of the setup command
## [v2.3.13] - 2017-04-09
### Fixed
- Issue when saving if template is not specified
## [v2.3.12] - 2017-04-09
### Fixed
- Issue with multilingual
- Issue with template parsing
## [v2.3.11] - 2017-04-09
### Added
- New block templating for pages
### Fixed
- Some minor doc issues
## [v2.3.10] - 2017-03-24
### Fixed
- Issue with empty value
## [v2.3.9] - 2017-03-07
### Changed
- Split a service into traits for easier management
### Fixed
- Menu loading issue
## [v2.3.8] - 2017-03-03
### Fixed
- More module template fixes
## [v2.3.7] - 2017-03-03
### Fixed
- Minor fixes for the module loader
- Fixed issue with module builder
## [v2.3.6] - 2017-03-03
### Fixed
- Issue with route vs url
## [v2.3.5] - 2017-03-03
### Fixed
- Minor issue with module crud
- Navigation issue
## [v2.3.4] - 2017-02-22
### Changed
- Minor style improvements
## [v2.3.3] - 2017-02-20
### Changed
- Minor style updates and improvements
## [v2.3.2] - 2017-02-19
### Added
- New sorting in the index pages for admin views
### Changed
- Updated the charts in the dashboard
## [v2.3.1] - 2017-02-13
### Fixed
- Fixes an issue with S3 storage
## [v2.3.0] - 2017-01-27
### Added
- New history and revert actions
- New module composer packager
- New internal analytics component
### Changed
- Laravel 5.4 compatibility
## [v2.2.12] - 2016-12-28
### Fixed
- Fixes issue with Minify breaking CDN libs
## [v2.2.11] - 2016-12-26
### Added
- New normalizer for entry content
- New image blade tags
## [v2.2.10] - 2016-12-15
### Added
- New middleware for language setting
### Changed
- Minor improvements
- Also added ability to customize dashboard
## [v2.2.9] - 2016-12-06
### Changed
- Readme updates
### Fixed
- Fixed issue with permissions and roles.
## [v2.2.8] - 2016-12-05
### Changed
- Added support for MySQL 5.6
## [v2.2.7] - 2016-12-05
### Fixed
- Incorrect text in config
## [v2.2.6] - 2016-12-05
### Added
- New db-prefix option for cabin tables
- New live preview in editor view
### Fixed
- Image loading times
## [v2.2.5] - 2016-11-17
### Fixed
- Minor fix for setup
## [v2.2.4] - 2016-11-10
### Fixed
- Minor issue with typos
## [v2.2.3] - 2016-11-09
### Fixed
- Fixed a couple issues which came from the Laracogs updates
## [v2.2.2] - 2016-11-04
### Changed
- Tweaked backend css and js
### Fixed
- Minor issue with route listing
## [v2.2.1] - 2016-10-30
### Added
- New logo and more customizations
### Changed
- Better migrations for archives and translations
### Fixed
- Minor UI flow issues
## [v2.2.0] - 2016-10-28
### Added
- Now with multilingual support
### Changed
- Internal improvements to UI and flow
### Fixed
- Better blog listing
- menu issue resolved
## [v2.1.3] - 2016-10-24
### Changed
- Updates to docs on landing page
### Fixed
- Minor issue with team leftover
## [v2.1.2] - 2016-10-21
### Added
- New tokens for API calls
### Changed
- Moved migrations to publish directory
### Fixed
- API requests with gateway
## [v2.1.1] - 2016-10-21
### Fixed
- Minor issues with quick setup
## [v2.1.0] - 2016-10-21
### Added
- New API layer for basic API requests
### Changed
- Renamed models and repositories with singular names. This requires updates to your app's PagesController etc.
### Fixed
- General improvements and fixes for simple setup
## [v2.0.1] - 2016-10-01
### Fixed
- Default to not loading modules
## [v2.0.0] - 2016-09-29
### Added
- Now supports Laravel 5.3
## [v1.4.24] - 2016-08-30
### Fixed
- Missing service provider
## [v1.4.23] - 2016-08-30
### Fixed
- More markdown issues
## [v1.4.22] - 2016-08-30
### Fixed
- Markdown issues
## [v1.4.21] - 2016-07-27
### Fixed
- Fixes some issues with the Module maker
## [v1.4.20] - 2016-07-25
### Fixed
- Fixed issues with templates and setup
## [v1.4.19] - 2016-07-11
### Changed
- General code quality improvements
## [v1.4.18] - 2016-07-09
### Fixed
- Fixes issue module providers
## [v1.4.17] - 2016-07-08
### Changed
- Set up markdown support with markdown template and blade directive
## [v1.4.16] - 2016-07-07
### Changed
- General improvements with WYSIWYG
- Code Style improvements
- Readme updates and refactoring
## [v1.4.15] - 2016-07-05
### Changed
- Merged in PR #16
## [v1.4.14] - 2016-07-04
### Added
- Images are now searchable
### Changed
- Minor cleanup
## [v1.4.13] - 2016-07-04
### Added
- New service provider support
### Changed
- Improved overall support of modules
### Fixed
- Add in missing helper methods
- Fixed improperly named columns
## [v1.4.12] - 2016-06-23
### Fixed
- Issue with quick install and missing Quarx in composer.json
## [v1.4.11] - 2016-06-22
### Changed
- Changed models for core elements to use guarded vs fillable for expandability
### Fixed
- Fixed some unit tests
## [v1.4.10] - 2016-06-21
### Fixed
- Fixed issue with file paths #10
## [v1.4.9] - 2016-06-13
### Fixed
- Missing tests key
## [v1.4.8] - 2016-06-13
### Fixed
- Issues resulting from the schema option on the crud generator
## [v1.4.7] - 2016-06-12
### Fixed
- Fixes default template issue
## [v1.4.6] - 2016-06-05
### Changed
- Removed ID and asset encryption for faster loading times.
### Fixed
- Missing schema generator
## [v1.4.5] - 2016-06-03
### Added
- Now supports S3
### Fixed
- Issue with public gallery and published_at
## [v1.4.4] - 2016-06-01
### Added
- New publish date
- Added event tracking and rollback for custom modules
### Changed
- Better template layouts internally.
## [v1.4.3] - 2016-05-31
### Added
- Auto-publish theme assets with quick start
- Auto gulp running
### Fixed
- Issues with quick start and composer dump
## [v1.4.2] - 2016-05-31
### Added
- Simple setup for fast website making
### Changed
- Moved the dashboard layout around
- Simple setup drops some of the Laracogs additions
## [v1.4.1] - 2016-05-31
### Changed
- Fixed naming issues
## [v1.4.0] - 2016-05-31
### Changed
- Switched uuid to slugs please update your database columns accordingly (widgets & menus)
- Also improved and updated the help information
## [v1.3.6] - 2016-05-26
### Added
- New Theme files for custom modules
### Changed
- Overall improvements
- Better module publishing
## [v1.3.5] - 2016-05-20
### Changed
- Improved loading times
- Improved encryption
- Improved performance
## [v1.3.4] - 2016-05-08
### Added
- Some stuff
- more stuff
### Fixed
- method1 something
## [v1.3.3] - 2016-05-06
### Added
- New changelog for easier tracking
### Changed
- Improved cryptography utilities
================================================
FILE: composer.json
================================================
{
"name": "grafite/cms",
"description": "Add a CMS to any Laravel app/website to gain control of: pages, blogs, galleries, events, custom modules, images and more.",
"license": "MIT",
"authors": [
{
"name": "Matt Lantz",
"email": "mattlantz@gmail.com"
}
],
"require": {
"php": ">=7.1.3",
"illuminate/support": "^5.7",
"grafite/crudmaker": "1.4.*",
"grafite/formmaker": "1.3.*",
"laravelcollective/html": "^5.7",
"devfactory/minify": "1.0.*",
"aws/aws-sdk-php": "^3.18",
"league/flysystem-aws-s3-v3": "^1.0",
"graham-campbell/markdown": "^10.0",
"intervention/image": "^2.4",
"stichoza/google-translate-php": "^3.2",
"donatj/phpuseragentparser": "^0.5.3"
},
"require-dev": {
"mockery/mockery": "~1.0",
"mikey179/vfsstream": "^1.6",
"orchestra/testbench": "^3.6",
"phpunit/phpunit": "~7.0"
},
"autoload": {
"psr-4": {
"Grafite\\Cms\\": "src/"
},
"files": [
"src/Helpers/blade.php",
"src/Helpers/general.php"
]
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
},
"classmap": [
"tests/factories/"
]
},
"minimum-stability": "dev",
"prefer-stable": true,
"extra": {
"laravel": {
"providers": [
"Grafite\\Cms\\GrafiteCmsProvider"
]
}
}
}
================================================
FILE: package.json
================================================
{
"private": true,
"scripts": {
"dev": "npm run development",
"development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
"prod": "npm run production",
"watch": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --watch --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
"production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --no-progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
},
"devDependencies": {
"axios": "^0.18",
"bootstrap": ">=4.1.2",
"cross-env": "^5.1",
"jquery": "^3.2",
"laravel-mix": "^2.1.14",
"lodash": "^4.17.4",
"popper.js": "^1.12",
"vue": "^2.5.7"
}
}
================================================
FILE: phpunit.xml
================================================