pavel-one / MicroPanel

Hosting micro panel

TODO

• Сделать нормальную документацию
• Авторизация
• Листинг и управления пользователями для sudo - админа
• Логирование очередей
• Профиль пользователя
• Внешний профиль пользователя
• Техническая поддержка
• Уведомления
• Услуги и тарифы
• Подсчет занимаемого места и т.д.
• Бэккапы

О проекте

Описание

Требования

• php 7.2
• Mysql 5.7

Установка

1. git clone https://github.com/pavel-one/MicroPanel.git
2. composer install
3. cp .env.example .env
4. php artisan key:generate
5. В .env меняем то что нужно поменять, следуем комментариям
6. php artisan migrate --seed
7. npm install
8. npm run watch

IDE Helper-commands

Это специальное дополнение, дабы помочь IDE понимать абстракции и фасады laravel

• php artisan ide-helper:models -W - Добавить автоматическую генерацию phpDoc для моделей
• php artisan ide-helper:generate - Генерация ide_helper файла
• composer run-script post-update-cmd - Обновить все

Правила мерджа

• Каждый человек работает в отдельной ветке которая отталкивается от мастера
• Название ветки должно быть максимально понятной и обозначать тот фронт работ, что вы взяли
• Мерджить в мастер категорически запрещено
• Каждый коммит относящийся к issue должен начинаться с id issue #24 CommitName
• Если мы создаем новую модель, мы обязательно делаем к ней сидеров

Делаем наш первый PR

1. Разворачиваем проект
2. Создаем новую ветку и переключаемся в нее
3. Делаем изменения в проекте, коммитим и пушим
4. Переходим в PR
5. Жмем New pull request
6. Base: master -> Compare: YourBranchName
7. Разрешаем конфликты и жмем Create pull request
8. Подробно описываем что сделали и какие дополнительные действия нужно произвести Если нужно
9. Reviewers и Assignees указываем Pavel Zarubin
10. Даже после PR можно дополнять коммитами его, но ДО его принятия ревьювером

Начинаем новую задачу

1. Создаем новую ветку
2. git pull origin master Вливаем в нее изменения из мастера
3. composer install - если были измнения с пакетами
4. php artisan migrate:refresh --seed - полностью перестраеваем бд с сидорами

Правила кода

• Бизнес - логику храним в сервисах
• Для логирования используем разные каналы, например если вы разрабатываете модуль оплаты, то канал для его логирования должен называться payment а логи кластся в отдельную папку
• Модели должны быть рассортированы по папкам
• Не забываем правильно указывать индексы в БД
• Модели создаем с миграциями, не по отдельности, это позволит избежать проблем php artisan make:model ComponentName/ModelName -m
• Модели всегда называются в единственном числе
• Если нам нужно изменить существующую таблицу, мы не меняем миграцию, а создаем отдельную
• Соблюдаем правильное именование сетеров и гетеров
• В именовании сервисов, моделей, переменных используем CamelCase а не SnakeCase
• Для контроллеров ресурсов обязательно ставим флаг resource php artisan make:controller ModelNameController --resource
• Если добавляется новый конфиг, добавляем его и в .env.example

Другое