Craftable
Craftable
3.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0
  • 7.0
  • 8.0

    • Installation

    Requirements

    Craftable requires:

    • PHP 7.1+
    • Supported databases:
      • MySQL 5.7+
      • PostgreSQL 9.5+
    • npm 5.3+
    • node 8.4+

    Craftable uses Laravel so you should check out its requirements too. It is compatible with Laravel 5.5, 5.6 and 5.7:

    New Craftable project

    If you want to start on fresh Laravel, you can use our brackets/craftable-installer that do all the tricks for you. Let's install it globally:

    composer global require "brackets/craftable-installer"

    {danger.fa-exclamation-triangle} Create an empty database of your choice (PostgreSQL or MySQL).

    Now you can create a new Craftable project:

    craftable new my_project

    This will install Craftable using latest Laravel version (currently 5.7). If you prefer tu use latest LTS Laravel version (currently 5.5), use --lts flag:

    craftable new --lts my_project

    The commands is going to ask for a database settings and then it will setup everything (install all dependencies, publish all important vendor configs, migrate, setup some configs, webpack config and run migrations).

    Command is going to generate and print the password for the default administrator account. Save this password to your clipboard, we are going to need it soon.

    Add Craftable to existing project

    Or alternatively, you can use your existing Laravel application. Start with requiring these two main packages:

    composer require brackets/craftable
composer require --dev brackets/admin-generator

    To install this package use:

    php artisan craftable:install

    This is going to install all dependencies, publish all important vendor configs, migrate, setup some configs, webpack config and run migrations.

    Command is going to generate and print the password for the default administrator account. Save this password to your clipboard, we are going to need it soon.

    Finally we need to compile all the assets using npm:

    npm install && npm run dev

    Login

    Once installed, navigate your browser to /admin/login. You should be able to see a login screen.

    Admin login form

    Use these credentials to log in:

    • E-mail: administrator@brackets.sk
    • Password: use password from you clipboard (it was printed in the end of the craftable:install command)

    After authorization you should be able to see a default homepage and two menu items:

    • Manage access
    • Translations

    Admin homepage

    Where to go next?

    At this point you are ready to start building your administration area. You probably want to start building a typical CRUD interface for your eloquent models. You should definitely check our Admin Generator documentation.

    In case you rather want to create some atypical custom made administration, then you probably want to head over to Admin UI package.

    Have fun & craft something awesome!