craftable

БОЛЬШИЕ НОВОСТИ

Мы только что выпустили Craftable PRO — премиум-версию популярного конструктора административной панели Laravel с открытым исходным кодом. Версия Pro поставляется со свежим пользовательским интерфейсом, созданным на основе Tailwind, использует новейшие версии Laravel и InertiaJS и содержит множество новых функций.

---

Craftable — создавайте панели администратора с помощью Laravel

• О
  • Демо
  • Используемые пакеты
• Требования
• Установка
  • Новый проект
  • Добавить в существующий проект
• Основы
• Документация
• Куда идти дальше?

О

Привет, Crafter, добро пожаловать в официальную документацию Craftable 6 — набора инструментов с открытым исходным кодом на основе Laravel для создания интерфейсов администрирования. Это минималистичный шаблон административной области. Отправная точка для разработки бэк-офисных систем, интранет-сетей или систем CMS.

Вы могли бы назвать это CMS, но она очень тонкая, с минимальным количеством контента, которым нужно управлять. Он имеет:

• UI — приятный шаблон администратора на основе CoreUI (http://coreui.io/)
• CRUD-генератор
• Авторизация, Мой профиль и Пользователи CRUD
• Менеджер переводов
• другие помощники для быстрой загрузки вашей новой административной области (медиатека, список администратора и т. д.)

Демо

Мы создали для вас демо-версию на https://demo.getcraftable.com.

Используйте эти учетные данные для входа:

• электронная почта: [email protected]
• пароль: demo123

Вы можете увидеть администрацию:

• Сообщения — это стандартный CRUD, созданный с помощью пакета admin-generator
• Переводимые статьи – это витрина translatable красноречивых моделей.
• Управление доступом — это расширенный CRUD для управления пользователями (ваша существующая красноречивая модель).
• Переводы - где вы можете управлять переводами, хранящимися в базе данных.

Из компонентов

Нашей целью было разделить все это на несколько пакетов с как можно меньшим количеством зависимостей. Вот что мы собираемся сделать на данный момент:

• Пользовательский интерфейс администратора — шаблон администратора (ресурсы CoreUI, блейды, Vue)
• Admin Generator — генератор CRUD для моделей Eloquent
• Аутентификация администратора — возможность авторизоваться в области администратора.
• Translatable — возможность иметь переводимый контент (расширение локализации Laravel по умолчанию).
• Листинг администратора — возможность быстро создать запрос на список администраторов для ваших моделей Eloquent.
• Медиатека — возможность прикреплять медиа к красноречивым моделям
• Admin Translations — менеджер переводов (с пользовательским интерфейсом)

Craftable использует все вышеперечисленные пакеты. Он также использует некоторые другие сторонние пакеты (например, spatie/laravel-permission от Spatie) и предоставляет базовую конфигурацию по умолчанию для ускорения разработки типичного интерфейса администрирования.

Требования

Для изготовления требуется:

• PHP 7.4+
• Поддерживаемые базы данных:
  • MySQL 5.7+
  • PostgreSQL 9.5+
• НПМ 5.3+
• узел 8.4+

Craftable использует Laravel, поэтому вам также следует ознакомиться с его требованиями. Он совместим с Laravel 8:

• https://laravel.com/docs/8.x/installation#server-requirements

Установка

Новый проект, который можно создать

Если вы хотите начать работу с новым Laravel, вы можете использовать наш brackets/craftable-installer который сделает всю работу за вас. Давайте установим его глобально:

composer global require " brackets/craftable-installer "

Создайте пустую базу данных по вашему выбору (PostgreSQL или MySQL).

Теперь вы можете создать новый проект Craftable:

craftable new my_project

При этом Craftable будет установлен с использованием последней версии Laravel (на данный момент 6). Если вы предпочитаете использовать последнюю версию LTS Laravel (в настоящее время также 6), используйте флаг --lts :

craftable new --lts my_project

Команды запросят настройки базы данных, а затем все настроят (установят все зависимости, опубликуют все важные конфигурации поставщиков, осуществят миграцию, настроят некоторые конфигурации, конфигурацию веб-пакета и запустят миграцию).

Команда сгенерирует и распечатает пароль для учетной записи администратора по умолчанию . Сохраните этот пароль в буфер обмена, он нам скоро понадобится.

Добавить Craftable в существующий проект

Или, альтернативно, вы можете использовать существующее приложение Laravel. Начните с требования этих двух основных пакетов:

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

Для установки этого пакета используйте:

php artisan craftable:install

Это позволит установить все зависимости, опубликовать все важные конфигурации поставщиков, выполнить миграцию, настроить некоторые конфигурации, конфигурацию веб-пакета и запустить миграцию.

Команда сгенерирует и распечатает пароль для учетной записи администратора по умолчанию . Сохраните этот пароль в буфер обмена, он нам скоро понадобится.

Основы

После установки перейдите в браузере по адресу /admin/login . Вы должны увидеть экран входа в систему.

Используйте эти учетные данные для входа в систему:

• Электронная почта: [email protected]
• Пароль: используйте пароль из буфера обмена (он был напечатан в конце craftable:install )

После авторизации вы сможете увидеть домашнюю страницу по умолчанию и два пункта меню:

• Управление доступом
• Переводы

Документация

Вы можете найти полную документацию по этому пакету и другим нашим пакетам, которые использует Craftable, по адресу https://docs.getcraftable.com/#/craftable.

Куда идти дальше?

На этом этапе вы готовы приступить к созданию своей административной области. Вероятно, вы захотите начать создавать типичный CRUD-интерфейс для своих красноречивых моделей. Вам обязательно следует ознакомиться с документацией по нашему генератору администратора.

Если вы предпочитаете создать нетипичное индивидуальное администрирование, вам, вероятно, захочется перейти к пакету Admin UI.

Развлекайтесь и создавайте что-то потрясающее!

Как внести свой вклад:

• Добавьте в репозиторий Github (необязательно)
  

• Прежде чем внести свой вклад, пожалуйста, прочтите CONTRIBUTING.md и CODE_OF_CONDUCT.md.

• Создайте проблему проекта или функцию, которую вы хотели бы добавить в проект, и назначьте себе задачу. (Проблема может заключаться в любых исправлениях ошибок или в любой функции, которую вы хотите добавить в этот проект).

• Форкните репозиторий на свой Github.
  

• Клонируйте репо, перейдя к локальному клиенту Git в определенной локальной папке на локальном компьютере, используя эту команду со ссылкой на разветвленный репозиторий вместо приведенной ниже ссылки:
  git clone https://github.com/BRACKETS-by-TRIAD/craftable

• Создайте ветку, используя команду ниже. git branch <your branch name>

• Оформление заказа в вашем отделении. git checkout <your branch name>

• Добавьте свой код в папку локального компьютера. git add .

• Зафиксируйте изменения. git commit -m"<add your message here>"

• Отправьте свои изменения. git push --set-upstream origin <your branch name>

• Сделайте запрос на вытягивание! (сравните свою ветку с основной веткой владельца)

Авторы

Слава этим замечательным людям

Лицензия

Лицензия МТИ. Дополнительную информацию см. в файле ЛИЦЕНЗИИ.