Download the PHP package typicms/base without Composer
On this page you can find all versions of the php package typicms/base. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package base
TypiCMS
TypiCMS is a modular multilingual content management system built with Laravel. Out of the box you can manage pages, events, news, places, menus, translations, etc.
Table of contents
- Features
- Requirements
- Installation
- Assets
- Locales configuration
- Installation of a module
- Available modules
- Pages
- Menus
- Projects
- Categories
- Tags
- Events
- News
- Contacts
- Partners
- Files
- Users and roles
- Blocks
- Translations
- Sitemap
- Settings
- History
- Facades
- Artisan commands
- Roadmap
- 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 >= 7.2
- MySQL 5.7.8
- BCMath PHP Extension
- Ctype PHP Extension
- JSON PHP Extension
- Mbstring PHP Extension
- OpenSSL PHP Extension
- PDO PHP Extension
- Tokenizer PHP Extension
- XML PHP Extension
Installation
First install Composer
-
Create a new project
-
Enter the newly created folder
- Migration of the database, seeding, user creation, npm installation and directory rights
Note: if you use MariaDB, set 'mariadb' to true in config/typicms.php
Go to http://mywebsite.test/admin and log in.
Assets
Assets are managed with Laravel Mix. In order to work on assets, you need to install Node.js, then go to your website folder and run these commands:
-
Install npm packages (in directory node_modules)
- Compile admin and public assets
Locales configuration
- Set the locales in config/typicms.php, the first key of this array is the main locale and should be the same as the locale defined in config/app.php.
- Set main_locale_in_url in config/typicms.php to true or false.
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, you can publish it!
-
Install a module with Composer
- Add
TypiCMS\Modules\News\Providers\ModuleServiceProvider::class,to config/app.php, beforeTypiCMS\Modules\Core\Providers\ModuleServiceProvider::class, -
Publish the views and migrations
- Migrate the database
Module scaffolding
Let’s create a module called Cats.
-
Create the module with artisan:
- The module is in /Modules/Cats, you can customize it
- Add
TypiCMS\Modules\Cats\Providers\ModuleServiceProvider::class,to config/app.php, beforeTypiCMS\Modules\Core\Providers\ModuleServiceProvider::class, - Migrate the database
Available modules
Each module can be published.
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. A page can have multiple sections.
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::render('menuname') or @menu('menuname').
Projects
Projects have categories, projects URLs follows this pattern: /en/projects/category-slug/project-slug
Tags
Tags are linked to projects and use the Selectize plugin. The tags module has many to many polymorphic relations so a tag can be easily linked to any module.
Events
Events have starting and ending dates.
News
News module.
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 and organize images, documents and folders. It works with DropzoneJS for the uploading proccess. Thumbnails are generated on the fly thanks to Croppa.
If you want to store the original images on a storage service such as Amazon s3 and your cropped images on the local disk, set FILESYSTEM_DRIVER=s3 in your .env file and in config/croppa.php set 'src_dir' => 'filesystem.default.driver' and 'crops_dir' => storage_path('app/public').
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 display the content of a block with Blocks::render('blockname') or @block('blockname').
Translations
Translations can be stored in the database through the admin panel (/admin/translations).
You can get a translation from the database with the standard Laravel functions: __('Key'), trans('Key') or @lang('Key').
Sitemap
A sitemap is generated by reading all pages available in your project. The URL is /sitemap.xml.
Settings
Change the website title, logo, and other options in the settings panel.
History
created, updated, deleted, online and offline actions are logged in database. 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/typicms/core/src/Commands
Installation of TypiCMS
Initial migration and seed
This command is triggered by typicms:install
Publish a module
If you want to modify a module, for example to add some fields or a relation, you have to publish it by running:
The module is now located in the /Modules directory.
These steps will be executed:
- Publishing of views and migrations for Pages module.
- Copying of everything excepted views and migrations from /vendor/typicms/pages/src to /Modules/Pages.
- Running
composer remove typicms/pages.
When a module is published, it will be tracked by git and you will be able to make changes in /Modules/Modulename directory without loosing changes when running composer update.
Changelog
Please see CHANGELOG for more information on what has changed.
Contributing
Please see CONTRIBUTING for details.
Credits
License
TypiCMS is an open-source software licensed under the MIT license.
