Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sdebacker/TypiCMS
Multilingual CMS built with Laravel 4.2
https://github.com/sdebacker/TypiCMS
cms laravel multilingual
Last synced: 3 months ago
JSON representation
Multilingual CMS built with Laravel 4.2
- Host: GitHub
- URL: https://github.com/sdebacker/TypiCMS
- Owner: sdebacker
- License: mit
- Created: 2014-03-18T11:30:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-10-22T07:04:09.000Z (about 3 years ago)
- Last Synced: 2024-07-13T07:35:20.868Z (4 months ago)
- Topics: cms, laravel, multilingual
- Language: PHP
- Homepage:
- Size: 24 MB
- Stars: 477
- Watchers: 61
- Forks: 119
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
This repository is deprecated, please use the latest [TypiCMS](https://github.com/TypiCMS/Base).
# TypiCMS for Laravel 4.2
[](https://gitter.im/sdebacker/TypiCMS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/sdebacker/TypiCMS)
[](https://packagist.org/packages/sdebacker/typicms)
[](https://packagist.org/packages/sdebacker/typicms)
[](https://scrutinizer-ci.com/g/sdebacker/TypiCMS/?branch=master)
[](https://insight.sensiolabs.com/projects/5c96a56f-2006-4911-bf7c-d9afad35db5a)
TypiCMS is a multilingual content management system built with [Laravel 4.2](http://laravel.com).
[Bower](http://bower.io) and [gulp](http://gulpjs.com) are used for asset management and the user interface is built with [Bootstrap 3](http://getbootstrap.com) with [Less](http://lesscss.org).
## Table of contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Quick installation](#quick-installation)
- [Manual installation](#manual-installation)
- [Bower & Gulp](#bower--gulp)
- [Configuration](#configuration)
- [Modules](#modules)
- [Pages](#pages)
- [Menus](#menus)
- [Projects](#projects)
- [Categories](#categories)
- [Tags](#tags)
- [Events](#events)
- [News](#news)
- [Contacts](#contacts)
- [Partners](#partners)
- [Files](#files)
- [Galleries](#galleries)
- [Users and groups](#users-and-groups)
- [Blocks](#blocks)
- [Translations](#translations)
- [Sitemap](#sitemap)
- [Settings](#settings)
- [History](#history)
- [Facades](#facades)
- [Artisan commands](#artisan-commands)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Testing](#testing)
- [Licence](#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.4.0
- MCrypt PHP Extension
- Memcached or Redis or APC
## Installation
### Quick installation
1. Install [Node.js](http://nodejs.org), [Bower](http://bower.io) and [gulp](http://gulpjs.com)
2. Create an empty MySQL database
3. Create a new project
```
composer create-project sdebacker/typicms mywebsite
```
4. Enter the newly created folder
```
cd mywebsite
```
5. DB migration and seed, user creation, npm installation, bower installation and directory rights
```
php artisan typicms:install
```
6. Go to http://mywebsite.local/admin and log in.
### Manual installation
1. Create an empty database
2. Download TypiCMS
```
git clone https://github.com/sdebacker/TypiCMS.git mywebsite
```
3. Enter the newly created folder
```
cd mywebsite
```
4. Install dependencies with [Composer](https://getcomposer.org/doc/00-intro.md)
```
composer install
```
5. Set a new encryption key
```
php artisan key:generate
```
6. Change the cache prefix in app/config/cache.php
```
php artisan cache:prefix yourCachePrefix
```
7. Rename .env.example to .env
```
mv .env.example .env
```
8. Fill in your database credentials in .env
9. Migrate and seed the database
```
php artisan migrate --seed
```
10. Set permissions
```
chmod -R 777 app/storage
chmod -R 777 public/uploads
```
11. Go to http://mywebsite.local/admin and log in:
* email: ```[email protected]```
* password: ```admin```
### Bower & Gulp
In order to work on assets, you need to install [Node.js](http://nodejs.org), [Bower](http://bower.io) and [gulp](http://gulpjs.com), then cd to your website folder and run these commands:
1. Install bower packages according to bower.json (directory app/assets/components)
```
bower install
```
2. Install gulp packages according to gulpfile.js (directory node_modules)
```
npm install
```
3. Compile admin and public assets
```
gulp
```
### Configuration
1. Set available locales and the default locale in app/config/app.php
2. Cache driver is set to memcached. You can change it to another taggable cache system such as redis in app/config/cache.php
## Modules
### Pages
Pages are nestable with drag and drop, on drop, URIs are generated and saved in the database. A page has routes for each translation.
### Menus
Each menu has nestable entries. One entry can be linked to a module, page, URI or URL.
You can get a HTML formated menu with ``` Menus::build('menuname') ```.
An icon can easily be added to a menu item by filling the icon class field.
### 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](https://brianreavis.github.io/selectize.js/) jQuery plugin.
The tags moudle 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](http://www.dropzonejs.com) to upload them.
Thumbnails are generated on the fly with [Croppa](https://github.com/BKWLD/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, for now only the news module is properly set up to support galleries.
### Users and groups
[Sentry 2](https://cartalyst.com/manual/sentry) is used to manage users, groups and permissions.
User registration can be enabled through the settings panel (/admin/settings).
### 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
History table records changes and 25 latest records are displayed in the back office’s dashboard. Logged actions are *created*, *updated*, *deleted*, *set online* and *set offline*.
It works for all modules except users and groups.
## Facades
Modules that have their own Facade: News, Events, Projects, Places, Partners, Galleries, Blocks, Files and Menus.
In your views, 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 app/TypiCMS/Commands
* Initialisation of TypiCMS
```
php artisan typicms:install
```
* Set cache key prefix in app/config/cache.php
```
php artisan cache:prefix yourCachePrefix
```
* Initial migration and seed
```
php artisan typicms:database
```
## Roadmap
* Improve user interface
* Implement modules as packages
* Build more tests
## Contributing
Feel free to fork and make pull requests directly on the master branch!
TypiCMS follows the [PSR-2](http://www.php-fig.org/psr/psr-2/) standard.
Thanks to [elvendor](https://github.com/elvendor) and [jekjek](https://github.com/jekjek) for their contributions!
## Testing
Some admin controllers are actually tested, more tests needed.
## License
TypiCMS is an open-source software licensed under the [MIT license](http://opensource.org/licenses/MIT).