webfactorybulgaria / base
Multilingual CMS built with Laravel 5
Installs: 291
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 403
Language:JavaScript
Type:project
Requires
- php: >=5.5.9
- adamwathan/form: ~0.8.9
- barryvdh/laravel-debugbar: ~2.0
- barryvdh/laravel-elfinder: ^0.3.6
- bkwld/croppa: ~4.4.0
- dimsav/laravel-translatable: 5.6.0
- edvinaskrucas/notification: ~5.1.0
- guzzlehttp/guzzle: ~6.0
- laracasts/presenter: ~0.2.1
- laracasts/utilities: ~2.1.0
- laravel/framework: ~5.2.35
- maatwebsite/laravel-sidebar: ~1.1.1
- propaganistas/laravel-translatable-bootforms: ~1.3.2
- roumen/feed: ~2.10.1
- spatie/laravel-permission: ~1.3.4
- webfactorybulgaria/blocks: ~4.1.0
- webfactorybulgaria/core: ~4.1.0
- webfactorybulgaria/dashboard: ~4.1.0
- webfactorybulgaria/files: ~4.1.0
- webfactorybulgaria/galleries: ~4.1.0
- webfactorybulgaria/history: ~4.1.0
- webfactorybulgaria/menus: ~4.1.0
- webfactorybulgaria/nestablecollection: ~1.1.1
- webfactorybulgaria/objects: ~4.1.0
- webfactorybulgaria/pages: ~4.1.0
- webfactorybulgaria/roles: ~4.1.0
- webfactorybulgaria/settings: ~4.1.0
- webfactorybulgaria/sitemap: ~4.1.0
- webfactorybulgaria/translations: ~4.1.0
- webfactorybulgaria/users: ~4.2.0
Requires (Dev)
- fzaninotto/faker: ~1.4
- laracasts/generators: ~1.1
- mockery/mockery: 0.9.*
- phpunit/phpunit: ~4.0
- symfony/css-selector: 2.8.*|3.0.*
- symfony/dom-crawler: 2.8.*|3.0.*
- dev-master
- v4.1.43
- v4.1.42
- v4.1.41
- v4.1.40
- v4.1.39
- v4.1.38
- v4.1.37
- v4.1.36
- v4.1.35
- v4.1.34
- v4.1.33
- v4.1.32
- v4.1.31
- v4.1.30
- v4.1.29
- v4.1.28
- v4.1.27
- v4.1.26
- v4.1.25
- v4.1.24
- v4.1.23
- v4.1.22
- v4.1.21
- v4.1.20
- v4.1.19
- v4.1.18
- v4.1.17
- v4.1.16
- v4.1.15
- v4.1.14
- v4.1.13
- v4.1.12
- v4.1.11
- v4.1.10
- v4.1.9
- v4.1.8
- v4.1.7
- v4.1.6
- v4.1.5
- v4.1.4
- v4.1.3
- v4.1.2
- v4.1.1
- v4.1.0
- v4.0.36
- v4.0.35
- v4.0.34
- v4.0.33
- v4.0.32
- v4.0.31
- v4.0.30
- v4.0.29
- v4.0.28
- v4.0.27
- v4.0.26
- v4.0.25
- v4.0.24
- v4.0.23
- v4.0.22
- v4.0.21
- v4.0.20
- v4.0.19
- v4.0.18
- v4.0.17
- v4.0.16
- v4.0.15
- v4.0.14
- v4.0.13
- v4.0.12
- v4.0.11
- v4.0.10
- v4.0.9
- v4.0.8
- v4.0.7
- v4.0.6
- v4.0.5
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- 4.0.0
- 2.9.0
- 2.8.18
- 2.8.17
- 2.8.16
- 2.8.15
- 2.8.14
- 2.8.13
- 2.8.12
- 2.8.11
- 2.8.10
- 2.8.9
- 2.8.8
- 2.8.7
- 2.8.6
- 2.8.5
- 2.8.4
- 2.8.3
- 2.8.2
- 2.8.1
- 2.8.0
- 2.7.30
- 2.7.29
- 2.7.28
- 2.7.27
- 2.7.26
- 2.7.25
- 2.7.24
- 2.7.23
- 2.7.22
- 2.7.21
- 2.7.20
- 2.7.19
- 2.7.18
- 2.7.17
- 2.7.16
- 2.7.15
- 2.7.14
- 2.7.13
- 2.7.12
- 2.7.11
- 2.7.10
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.4
- 2.7.3
- 2.7.2
- 2.7.1
- 2.7.0
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.1
- 2.6.0
- 2.5.21
- 2.5.20
- 2.5.19
- 2.5.18
- 2.5.17
- 2.5.16
- 2.5.15
- 2.5.14
- 2.5.13
- 2.5.12
- 2.5.11
- 2.5.10
- 2.5.9
- 2.5.8
- 2.5.7
- 2.5.6
- 2.5.5
- 2.5.4
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.34
- 2.4.33
- 2.4.32
- 2.4.31
- 2.4.30
- 2.4.29
- 2.4.28
- 2.4.27
- 2.4.26
- 2.4.25
- 2.4.24
- 2.4.23
- 2.4.22
- 2.4.21
- 2.4.20
- 2.4.19
- 2.4.18
- 2.4.17
- 2.4.16
- 2.4.15
- 2.4.14
- v2.4.13
- v2.4.12
- v2.4.11
- 2.4.10
- 2.4.9
- 2.4.8
- 2.4.7
- 2.4.6
- 2.4.5
- 2.4.4
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- v2.3.3
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.8
- v2.2.7
- v2.2.6
- v2.2.5
- v2.2.4
- v2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.13
- v2.1.12
- v2.1.11
- v2.1.10
- v2.1.9
- v2.1.8
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.64
- v2.0.63
- v2.0.62
- v2.0.61
- v2.0.60
- v2.0.59
- v2.0.58
- v2.0.57
- v2.0.56
- v2.0.55
- v2.0.54
- v2.0.53
- v2.0.52
- v2.0.51
- v2.0.50
- v2.0.49
- v2.0.48
- v2.0.47
- v2.0.46
- v2.0.45
- v2.0.44
- v2.0.43
- v2.0.42
- v2.0.41
- 2.0.40
- 2.0.39
- 2.0.38
- 2.0.37
- 2.0.36
- 2.0.35
- 2.0.34
- v2.0.33
- v2.0.32
- v2.0.31
- v2.0.30
- v2.0.29
- v2.0.28
- v2.0.27
- v2.0.26
- v2.0.25
- v2.0.24
- v2.0.23
- v2.0.22
- v2.0.21
- v2.0.20
- v2.0.19
- v2.0.18
- v2.0.17
- v2.0.16
- v2.0.15
- v2.0.14
- v2.0.13
- v2.0.12
- v2.0.11
- v2.0.10
- v2.0.9
- v2.0.8
- v2.0.7
- v2.0.6
- v2.0.5
- V2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.8.5
- 1.8.4
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8.0
- dev-testhrist
- dev-dev
This package is not auto-updated.
Last update: 2024-11-09 18:43:36 UTC
README
Admintool4 is a modular multilingual content management system built with Laravel 5.2 based on TypiCMS. Out of the box you can manage pages, events, news, places, sliders, etc.
Table of contents
- Features
- Requirements
- Installation
- Modules
- Facades
- Artisan commands
- Roadmap
- Upgrade instructions
- Change log
- Contributing
- Credits
- Licence
Features
URLs
This kind of URLs are managed by the CMS:
Modules:
- /en/events/slug-in-english
- /fr/evenements/slug-en-francais
Pages:
- /en/parent-pages-slug-en/subpage-slug-en/page-slug-en
- /fr/parent-pages-slug-fr/subpage-slug-fr/page-slug-fr
Requirements
- PHP >= 5.5.9
- OpenSSL PHP Extension
- Mbstring PHP Extension
- Tokenizer PHP Extension
- Memcached or Redis
Installation
First install Node.js and gulp
-
Create a new project
composer create-project webfactorybulgaria/base mywebsite
-
Enter the newly created folder
cd mywebsite
-
DB migration and seed, user creation, npm installation and directory rights
php artisan admintool:install
Go to http://mywebsite.local/admin and log in.
npm & Gulp
In order to work on assets, you need to install Node.js and gulp, then cd to your website folder and run these commands:
-
Install gulp packages according to gulpfile.js (directory node_modules)
npm install
-
Compile admin and public assets
gulp all
Configuration
- Set locales in config/translatable.php.
- Set fallback_locale in config/app.php.
- Set main_locale_in_url in config/typicms.php to true or false.
- Cache driver is set to array, you can change it to another taggable cache system such as redis or memcached in your .env file.
Installation of a module
This example is for the News module. After these steps, the module will appear in the sidebar of the back office. If you need to customize it, publish it!
-
Install module with Composer
composer require webfactorybulgaria/news
-
Add
TypiCMS\Modules\News\Shells\Providers\ModuleProvider::class,
to config/app.php, beforeTypiCMS\Modules\Core\Shells\Providers\ModuleProvider::class,
-
Publish views and migrations
php artisan vendor:publish
-
Migrate the database
php artisan migrate
Module scaffolding
This example is for a new module called Cats.
-
Create the module with artisan:
php artisan admintool:create cats
-
The module is in /Modules/Cats, you can customize it
-
Add
TypiCMS\Modules\Cats\Shells\Providers\ModuleProvider::class,
to config/app.php, beforeTypiCMS\Modules\Core\Shells\Providers\ModuleProvider::class,
-
Migrate the database
php artisan migrate
Existing modules
Each module can be published in order to be modified and tracked by git. Here is more info on publishing a module.
Pages
Pages are nestable with drag and drop, on drop, URIs are generated and saved in the database. Each translation of a page has its own route. A page can be linked to a module.
Menus
Each menu has nestable entries. One entry can be linked to a page or URL.
You can return a HTML formated menu with Menus::build('menuname')
.
Projects
Projects have categories, projects URLs follows this pattern: /en/projects/category-slug/project-slug
Categories
Categories have many projects.
Tags
Tags are linked to projects and use the Selectize jQuery plugin. The tags module has many to many polymorphic relations so it could easily be linked to other modules.
Events
Events have starting and ending dates.
News
Simple news module with linked files/images galleries.
Contacts
Frontend contact form and admin side records management.
Partners
A partner has a logo, website URL, title and body content.
Files
The files module allows you to upload multiple files. It uses DropzoneJS to upload them. Thumbnails are generated on the fly with Croppa.
Galleries
You can create as many galleries as you want, each gallery has many files. Galleries are linkable to any module item through a polymorphic many to many relation.
Users and roles
User registration can be enabled through the settings panel (/admin/settings). Roles and Permissions are managed with spatie/laravel-permission.
Blocks
Blocks are useful to display custom content in your views.
You can get the content of a block with Blocks::build('blockname')
.
Translations
Translations can be stored in the database through the admin panel (/admin/translations).
You can call DB translation everywhere with Lang::get('db.Key')
, trans('db.Key')
or @lang('db.Key')
.
Sitemap
Route sitemap.xml generates a sitemap file in XML format. To add modules to the site map configure app/config/sitemap.php.
Settings
Change website title, and other options trough the settings panel. Settings are saved in the database
History
created, updated, deleted, online and offline actions are logged in database. 25 latest records are displayed in the back office’s dashboard.
Facades
Each modules has a facade that give you access to the repository, you can call for example News::latest(3)
to get the three latest news.
Check available methods in each module’s repository.
Artisan commands
Commands are located in /vendor/admintool/core/src/Commands
Installation of Admintool4
php artisan admintool:install
Set cache key prefix in app/config/cache.php
php artisan cache:prefix yourCachePrefix
This command is triggered by admintool:install
Initial migration and seed
php artisan typicms:database
This command is triggered by admintool:install
Clean the directory public/html
php artisan clear-html
Publish a module
If you want to modify a module, for example add some fields or a relation, you can not do it easily because each module is in vendor directory. Each TypiCMS class has its empty "Shell Class". This is an empty class which extends the base one and that is the one used in the entire CMS. When you publish a module all Shell classes are copied to the /Modules directory where you can easily override methods and properties. For example, the module Pages will be published by running this command:
php artisan admintool:publish pages
This will copy everything from /vendor/typicms/pages/src/Shells to /Modules/Pages/Shells.
Then in order for these new classes to take precedence you will have to
- Add this to your composer.json file: "TypiCMS\Modules\Pages\Shells\": "Modules/Pages/Shells/"
- Run
composer dump-autoload
This way you will gain full controll of the module and in the same time you will be able to still update the module from the main repository if needed.
Create a module
You can easily scaffold a module, for a module named Cats, run this command:
php artisan admintool:create cats
##Upgrade instructions
See the Wiki for upgrade instructions
Change log
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
Admintool4 is an open-source software licensed under the MIT license.