ims laravel admin starter

Об этом проекте

ims-laravel-admin-starter — это оптимизированное стартовое приложение с панелью администратора и API, созданное с использованием мощной платформы Laravel 10 и Filment 3.

Наша основная цель — предоставить вам простой и готовый к использованию стартовый проект локальной разработки.

В отличие от традиционных генераторов API или генераторов кода, этот проект упрощает процесс настройки локальной среды разработки. Это позволяет вам без лишних сложностей приступить к разработке API на основе Laravel и разработке панели администратора. Это позволяет вам сосредоточиться на построении логики приложения, а не тратить время на первоначальную настройку.

Функции

• Полная система аутентификации . Внедрите надежную систему аутентификации с использованием пакета Laravel Jetstream для безопасного управления пользователями и функций входа в систему.

• Система авторизации на основе ролей и разрешений . Создайте гибкую систему авторизации с помощью пакета Laravel-Permission, позволяющую определять роли и разрешения для детального контроля доступа.

• Управление пользователями : эффективное управление пользователями, включая регистрацию пользователей, обновления профилей и роли пользователей.

• Настройки профиля : позволяют пользователям настраивать свои профили, включая личную информацию и предпочтения.

• Поддержка нескольких языков . Сделайте свое приложение доступным для глобальной аудитории с помощью пакетов Filament Translations и Laravel Lang для многоязычной поддержки.

• Настройка темы : Настройте внешний вид приложения и пользовательский интерфейс, используя возможности Tailwind CSS, для создания визуально привлекательного дизайна.

• Поддержка Docker : легко развертывайте свое приложение и управляйте им в контейнере Docker с помощью Laravel Sail для оптимизации рабочих процессов разработки и развертывания.

Требования к версии

• Узел 16+
• PHP версии 8.1+
• MySQL версии 8.0+

Быстрый старт

1. Выберите свой локальный инструмент разработки:

   Выберите предпочитаемый вами локальный инструмент разработки, например Laragon, XAMPP, WAMP или любой другой инструмент, соответствующий вашим потребностям.

2. Настройте свою среду:

   Обновите файл .env , указав правильные учетные данные базы данных.

3. Установите зависимости:

   Запустите следующую команду, чтобы установить необходимые зависимости с помощью Composer:

   composer install

   Запустите следующую команду, чтобы установить необходимые зависимости с помощью npm и собрать их:

   npm install
   npm run build

4. Миграция и заполнение базы данных. Инициализируйте и заполните базу данных данными по умолчанию, используя:

   php artisan migrate --seed

   Теперь ваш проект готов к использованию. Вы можете получить доступ к панели администратора по указанному маршруту. Если вы запустили команду «seed», войдите в систему, используя предоставленные учетные данные. Настраивайте и расширяйте свое приложение по мере необходимости.

Доступ к панели администратора

После того, как вы настроили проект, используя предоставленные инструкции, вы можете получить доступ к панели администратора, посетив маршрут /admin в своем веб-браузере.

Вход в систему

Если вы запустили команду Seed во время процесса установки, вы можете войти в систему, используя следующие учетные данные:

email: [email protected]
password: 123456

email: [email protected]
password: 123456

Операции на основе ролей и разрешений

ims-laravel-admin-starter поддерживает операции на основе ролей и разрешений для управления доступом к различным функциям вашей панели администратора. Вы можете определить роли с определенными разрешениями и при необходимости назначать их пользователям.

Изучите этот проект и оцените удобство готовой локальной среды разработки для ваших API-интерфейсов и панелей администратора на основе Laravel.

Многоязычная поддержка

Повысьте доступность и удобство для пользователя этого начального проекта, используя несколько языков. При содействии Filament Translations и пакета Laravel Lang этот стартовый проект предлагает комплексную многоязычную поддержку.

Подробное руководство по работе с несколькими языками и переводами можно найти на нашей специальной вики-странице.

Откройте мир возможностей благодаря плавной языковой локализации, гарантируя, что ваше приложение найдет отклик у глобальной аудитории.

Запуск приложения с помощью Docker и Laravel Sail

Более подробное руководство можно найти на странице WIKI на GitHub:

Запуск приложения с помощью Docker и Laravel Sail — Wiki

Этот подробный ресурс содержит пошаговые инструкции и дополнительную информацию, которые обеспечат удобство настройки и запуска вашего приложения с помощью Docker и Laravel Sail.

Запуск теста

Чтобы обеспечить надежность и корректность вашего приложения, важно выполнять тесты. Выполните следующие простые шаги:

1. Создайте отдельную тестовую базу данных:

   Начните с создания специальной тестовой базы данных для вашего приложения. Вы можете назвать его ims-admin-testing чтобы он отличался от вашей производственной базы данных.

   Если вы используете Docker и Laravel Sail, вы можете пропустить этот шаг и вместо этого обновить файл phpunit.xml, чтобы добавить базу данных тестирования:

   < env name = " DB_DATABASE " value = " testing " />

2. Запуск тестов:

   У вас есть два удобных варианта запуска тестов:

   • Использование Пешта:

     Выполняйте тесты с помощью Pest, восхитительной среды тестирования PHP. Просто запустите следующую команду:

     ./vendor/bin/pest

     Если вы используете Sail, вы можете использовать эту команду:

     ./vendor/bin/sail test
     # or if you have an alias configured:
     sail test

   • Использование Артисана:

     Инструмент командной строки Artisan от Laravel обеспечивает широкие возможности тестирования. Запустите тесты с помощью следующей Artisan-команды:

     php artisan test

     Если вы используете Sail, вы можете использовать эту команду:

     ./vendor/bin/sail artisan test
     # or if you have an alias configured:
     sail artisan test

Выполнение тестов имеет решающее значение для обеспечения надежности и правильности функциональности вашего приложения. Приведенные выше команды инициируют процесс тестирования и предоставят вам ценную информацию о качестве вашей кодовой базы.

Советы по производительности

Несколько советов по производительности нити накаливания

Кэш иконок

Чтобы оптимизировать производительность приложения Filament, вы можете использовать команду php artisan icons:cache для кэширования значков. Эта команда предварительно загружает и кэширует значки, используемые в вашем приложении, что ускоряет загрузку.

php artisan icons:cache

Отключение коллекции представлений в панели отладки

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

1. Перейдите к файлу конфигурации debugbar.php расположенному в каталоге config вашего приложения.

2. Внутри файла debugbar.php вы найдете массив с именем collectors . Найдите сборщик 'views' в этом массиве.

3. Чтобы отключить коллекцию представлений, просто установите для коллектора 'views' значение false , например:

 ' collectors ' => [
    ...
    ' views ' => false,  // Views with their data
],

Это изменение не позволит панели отладки собирать и отображать данные представления, что может помочь повысить производительность вашего приложения, особенно в среде разработки.

Дополнительные ремесленные команды

Этот проект предоставляет дополнительные команды Artisan для упрощения рабочего процесса и повышения производительности.

Создайте вспомогательные файлы IDE:

Создайте общие вспомогательные файлы IDE для улучшения автозаполнения кода и навигации, выполнив:

php artisan ide-helper:generate

Создавайте вспомогательные файлы модели IDE без записи в файлы модели, используя:

 # use any one of this two commands
php artisan ide-helper:models -N
php artisan ide-helper:models --nowrite

Запустите PHP CS Fixer

php artisan csfixer:run

Эта команда гарантирует, что ваш код соответствует предопределенным стандартам кодирования, что делает вашу кодовую базу чистой и читаемой.

Создать сервис

Создание сервисов для вашего приложения становится проще. Используйте следующую команду для создания службы:

php artisan make:service subfolder/ServiceName

Замените подпапку и ServiceName фактическими значениями, которые вам нужны. Вы также можете создать сервис без подпапки:

php artisan make:service TestService

Вновь созданная служба будет расположена по адресу app/Http/Services/TestService.php и готова обрабатывать бизнес-логику вашего приложения.

Создать черту

Трейты — это повторно используемые компоненты кода, которые улучшают организацию кода. Чтобы создать новый признак, просто запустите:

php artisan make:trait TestTrait

Эта команда создает новый файл свойств для вашего проекта, обеспечивая возможность повторного использования кода и удобство сопровождения.

Используйте эти команды Artisan, чтобы оптимизировать процесс разработки и поддерживать хорошо структурированную базу кода.

Авторы

• @AHS12

Лицензия

Этот проект представлен вам компанией Innovix Matrix System и выпущен как программное обеспечение с открытым исходным кодом под лицензией MIT.

Не стесняйтесь использовать, изменять и распространять этот стартовый проект в соответствии с условиями лицензии MIT. Мы поощряем сотрудничество и приветствуем вклад сообщества, чтобы сделать этот проект еще лучше.