diff --git a/README.md b/README.md index f46093f..582f8d8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ -# Zertex CMS - Site management system based on Yii2 framework +Zertex CMS +========== +##Site management system based on Yii2 framework + +### Installation + +To install Zertex CMS, go to the web (web, www, public_html, etc.) folder of your site in the console and type +``` +composer create-project zertex/zxcms --keep-vcs +``` +After creating the project, type in the console +``` +php setup.php +``` +After completing the setup, the system will be available at the following urls ++ http://domain.com - Public website ++ http://admin.domain.com - Control Panel ++ http://static.domain.com - Image storage -## Alpha version Documentation is at [docs/guide/README.md](docs/guide/README.md). + +Developer russian documentation is at [docs/developer/README.md](docs/developer/README.md). \ No newline at end of file diff --git a/docs/develope/Modules.md b/docs/developer/Modules.md similarity index 68% rename from docs/develope/Modules.md rename to docs/developer/Modules.md index 77d1122..9a537e0 100644 --- a/docs/develope/Modules.md +++ b/docs/developer/Modules.md @@ -2,6 +2,23 @@ Модули располагаются в папке `common/modules` +После установки папка с модулями содержит только обязательные системные модули. + +**Для добавления готовых модулей сделайте следующее:** ++ Создайте в папке `common/modules` папку с названием выбранного модуля ++ Перейдите в эту папку в консоли ++ Клонируйте в нее модуль, например для блога +```bash +git clone https://gitlab.com/zertex/zxcms-blog.git . +``` +После клонирования перейдите в контрольной панели к списку модулей. +Будет создана запись в таблице `module` о данном модуле. После его включения автоматически будут применены миграции модуля. + +**Создание нового модуля** + +Создайте в папке `common/modules` папку с названием модуля. +Название должно состоять из строчных букв латинского алфавита и цифр. + Папка модуля должна содержать основной файл, например, `BlogModule.php` следующего содержания ```php