README

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.

Features
Requirements
Installation
Available modules
- Pages
- Menus
- Projects
- Categories
- Tags
- Events
- News
- Contacts
- Partners
- Files
- Users and roles
- Blocks
- Translations
- Sitemap
- Settings
- History
Artisan commands
Roadmap
Change log
Contributing
Credits
Licence

Features

URLs

The CMS manages this kind of URL:

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

Server Requirements

See Laravel requirements

Installation

First install Composer

Create a new project

composer create-project typicms/base mywebsite

Enter the newly created folder
```
cd mywebsite
```
Migration of the database, seeding, user creation, npm packages installation and directory permissions.
```
php artisan typicms:install
```

Go to http://mywebsite.test/admin and log in.

Assets

Assets are bundled with Vite. In order to work on assets, you can install Bun, then go to your website folder and run these commands:

Install npm packages (in directory node_modules)
```
bun install
```
Compile admin and public assets
```
bun run dev
```

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
```
composer require typicms/news
```
Add TypiCMS\Modules\News\Providers\ModuleServiceProvider::class, to config/app.php, before TypiCMS\Modules\Core\Providers\ModuleServiceProvider::class,
Publish the views and migrations
```
php artisan vendor:publish
```
Migrate the database
```
php artisan migrate
```

Module scaffolding

Let’s create a module called Cats.

Create the module with artisan:
```
php artisan typicms:create cats
```
The module is in /Modules/Cats, you can customize it
Add TypiCMS\Modules\Cats\Providers\ModuleServiceProvider::class, to config/app.php, before TypiCMS\Modules\Core\Providers\ModuleServiceProvider::class,
Migrate the database
```
php artisan migrate
```

Available modules

Each module can be published.

Pages

Pages are nestable with drag and drop, on a 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 an HTML formated menu in a blade file with @menu('menuname').

Projects

Projects have categories, projects URLs follow this pattern: /en/projects/category-slug/project-slug

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 Uppy for the uploading process. 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 the database. The latest records are displayed in the back office’s dashboard.

Artisan commands

Commands are located in /vendor/typicms/core/src/Commands

Installation of TypiCMS

php artisan typicms:install

Initial migration and seed

php artisan typicms:database

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:

php artisan typicms:publish <modulename>

The module is now located in the /Modules directory.

These steps will be executed:

Publishing of views and migrations for the Core module.
Copying of everything excepted views and migrations from /vendor/typicms/core/src to /Modules/Core.
Running composer remove typicms/core.

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 open-source software licensed under the MIT license.

typicms / base

Maintainers

Package info

Fund package maintenance!

Statistics

Security