README

mrcore/wiki is a module for the mRcore Framework

This module provides wiki and CMS dynamic app loading functionality.

Installation

Assuming you already have Laravel and mRcore Framework installed along with mRcore Auth Module

composer require mrcore/wiki:5.8.*
composer require mrcore/bootswatch-theme:5.8.*

Edit your config/modules.php file and ensure 'Mrcore\Wiki' => [], is set in your modules array

'modules' => [
    #...
    'Mrcore\Wiki' => []
    #...
]

And ensure Mrcore\Wiki is set in all 3 assets, views and routes arrays under the "Loading Order / Override Management" section. Notice Mrcore\Wiki is defined first in the routes array. Follow the order of each array listed

#...
'assets' => [
    '%app%',
    'Mrcore\BootswatchTheme',
    'Mrcore\Auth',
    'Mrcore\Wiki',
],

'views' => [
    '%app%',
    'Mrcore\Auth',
    'Mrcore\Wiki',
    'Mrcore\BootswatchTheme',
],

'routes' => [
    'Mrcore\Wiki',
    '%app%',
    'Mrcore\Auth',
    'Mrcore\Foundation',
],
#...

Edit your config/auth.php file and set guards web driver to mrcore

    'guards' => [
        'web' => [
            'driver' => 'mrcore',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'token',
            'provider' => 'users',
        ],
    ],

And set profiders users model to Mrcore\Auth\Models\User::class

    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => Mrcore\Auth\Models\User::class,
        ],
    ],

Run auth and wiki migrations and seeders

./artisan mrcore:auth:app db:migrate
./artisan mrcore:wiki:app db:migrate
./artisan mrcore:auth:app db:seed
./artisan mrcore:wiki:app db:seed

Visit your laravel install (if php artisan server at http://localhost:8000) to see the new wiki

Default user/pass is admin / password

What Is mRcore

mRcore is a module/package system for Laravel allowing you to build all your applications as reusable modules. Modules resemble the Laravel folder structure and can be plugged into a single Laravel instance. mRcore solves module loading dependency order and in-place live asset handling. Modules can be full web UIs, REST APIs and/or full Console command line apps. A well built module is not only your UI and API, but a shared PHP library, a native API or repository which can be reused as dependencies in other modules.

We firmly believe that all code should be built as modules and not in Laravel's directory structure itself. Laravel simply becomes the "package server". A single Laravel instance can host any number of modules.

See https://github.com/mrcore5/framework for details and installation instructions.

Versions

1.0 is for Laravel 5.1 and below
2.0 is for Laravel 5.3, 5.4, 5.5
5.6 is for Laravel 5.6
5.7 is for Laravel 5.7
... Following Laravel versions from here on

Contributing

Thank you for considering contributing to the mRcore framework! Fork and pull!

License

mRcore is open source software licensed under the MIT license

Enhancement Ideas

NO-Foundation installer should prompt and notify about to delete laravel models, migrations...
Build mrcore5-installer symfony console command to install fresh laravel + foundation. Options for --wiki install or --blog or whatever.
Perfect entities with mreschke/repository for auth, foundation and wiki. Split tables between them
DONE-Change namespace of bootswatch theme, maybe just Mrcore/BootswatchTheme ?

Wiki Tables

badges
comments
formats (wiki, php, phpw, html, text, markdown, htmlw)
frameworks (custom, workbench)
hashtags
modes (default, simple, raw, source)
post_badges
post_indexes
post_locks
post_permissions
post_reads
post_tags
posts
revisions
router
tags
types (doc, page, app)

$wiki = App::make('Mrcore\Wiki');

Auth Tables

permissions (update with per type, like wiki, or user, or blog...)
roles
user_permissions
user_roles
users

$auth = App::make('Mrcore\Auth'); $user = $auth->user->find(3); $user->roles; $user->permissions;

mrcore / wiki

Maintainers

Details