README

Description

Adminaut is the open-source platform for rapid development of PHP applications with the automatic construction of administration backend.

It's built on the top of PHP, Zend Framework, Doctrine ORM and other frameworks.

Installation

1. Install with Composer

Install the latest stable version with Composer:

composer require adminaut/adminaut

Or install the latest develop version with Composer:

composer require adminaut/adminaut:dev-develop

Or install manually by adding value "adminaut/adminaut": "dev-master" into composer.json file to "require" object and running command:

composer install

2. Enable module in your application

Composer should automatically enable Adminaut module and other required modules during installation.

In case it does not, you can enable module manually by adding values to array in file config/modules.config.php. At the end, it should look like PHP array below.

<?php
// config/modules.config.php

return [
    'Zend\Mail',
    'Zend\Router',
    'Zend\Validator',
    'DoctrineModule',    // Add this line, before Adminaut module.
    'DoctrineORMModule', // Add this line, before Adminaut module.
    'TwbBundle',         // Add this line, before Adminaut module.
    'Adminaut',          // Add this line, before Application module.
    'Application',
];

3. Set up your configuration

Look into the file vendor/adminaut/adminaut/config-dist/adminaut.global.php.dist and vendor/adminaut/adminaut/config-dist/adminaut.local.php.dist and copy it's content to your application config.

4. Set up Doctrine connection

https://github.com/doctrine/DoctrineORMModule.

5. Create/update DB

You need to create Adminaut entities.

If you don't have DB yet, run command:

vendor/bin/doctrine-module orm:schema-tool:create

If you already have some DB and some data in it, check what will be updated with command:

vendor/bin/doctrine-module orm:schema-tool:update --dump-sql

and if everything is OK, then run command:

vendor/bin/doctrine-module orm:schema-tool:update --force

Links

• Adminaut translation project at Crowdin

Browser Support (admin)

• IE 9+
• Firefox (latest)
• Chrome (latest)
• Safari (latest)
• Opera (latest)

Credits

Adminaut is build with:

• PHP
• Zend Framework
• Doctrine Project
• AdminLTE Control Panel Template
• Bootstrap 3
• Font Awesome
• Crowdin

License

Adminaut is an open source project by Moviatic s.r.o. that is licensed under MIT. Moviatic s.r.o. reserves the right to change the license of future releases.