README

CMSGears 基本模板

CMSGears 基本模板是一个用于开发基于 CMSGears 的 Web 应用程序的骨架CMSGears应用程序，非常适合利用核心模块（包括 Core、Forms、Newsletter、Notify 和 SNS Connect）开发。

该模板包括四个级别：REST、前端、后端和控制台，每个都是单独的 Yii 应用程序。

该模板旨在在团队开发环境中使用。它支持在不同环境中部署应用程序。

基本模板专门用于开发小型和中型 Web 应用程序，并支持移动应用程序，无需复杂模块，如 CMS 模块、社区模块等。如果您需要 CMS 系统或基于 CMS 的模块，请查看其他模板，包括博客、新闻和商店。

目录结构

common
    config/              contains shared configurations
    mail/                contains view files for e-mails
    models/              contains model classes used in REST, backend and frontend
    services/            contains shared services used in REST, backend and frontend
    tests/               contains tests for common classes
console
    components/          contains console components
    config/              contains console configurations
    controllers/         contains console controllers (commands)
    migrations/          contains database migrations
    models/              contains console-specific model classes
    runtime/             contains files generated during runtime
    services/            contains console services
backend
    assets/              contains application asset classes
    config/              contains backend configurations
    controllers/         contains Web controller classes
    models/              contains backend-specific model classes
    runtime/             contains files generated during runtime
    services/            contains backend-specific services
    tests/               contains tests for backend application
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
frontend
    assets/              contains application asset classes
    config/              contains frontend configurations
    controllers/         contains Web controller classes
    models/              contains frontend-specific model classes
    runtime/             contains files generated during runtime
    services/            contains frontend-specific services
    tests/               contains tests for frontend application
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
rest
    config/              contains REST configurations
    controllers/         contains REST controller classes
    models/              contains rest-specific model classes
    runtime/             contains files generated during runtime
    services/            contains rest-specific services
    tests/               contains tests for REST application
    web/                 contains the entry script
modules/    	         contains the project modules
templates/    	         contains the project templates
themes/                  contains the template themes
uploads/    	         contains the uploaded files
widgets/    	         contains the template widgets
environments/            contains environment-based overrides
vendor/                  contains dependent 3rd-party packages

模块、插件和小部件

它预先安装了 Core、Forms、Newsletter、Notify、SNS Connect 和 SMS 模块。
它预先安装了 Assets、Breeze Templates、File Manager、Social Meta 和 Icon Picker 插件。
基本模板默认包含的 widget 包括 CLEditor、TinyMCE、评论、块、导航、登录、画廊、Newsletter、表单、AJAX 表单、标签、类别、社交、弹出和网格。
它还预先安装了 CMSGears 的 FoxSlider 插件。
除了第 1 至 3 点中指定的模块、插件和小部件之外，该模板还针对多个第三方资源进行了配置，包括 conditionizr、moment、chart.js 等。

主题

管理员主题提供用于管理和配置模块和插件的布局。
该模板预先配置为使用基本主题作为前端。
基本主题可以被视为您应用程序的起点。它旨在根据项目需求进一步更新，将其作为基础。

模板详细信息

基本模板是一组用于管理后端、前端、控制台和 REST 应用程序的目录和配置文件。

它还提供了带有测试数据的迁移脚本。

模板演示

前端 - https://demo.cmsgears.com/templates/basic (demouser@cmsgears.com, test#123)
管理员 - https://demo.cmsgears.com/templates/basic/admin (demomaster@cmsgears.com, test#123)

在演示网站上禁用了实时电子邮件，并且数据库每小时重置一次。

模板安装

基本模板可以通过 composer 使用以下命令安装。有关如何安装 composer 的说明，请参阅官方网站 https://getcomposer.org.cn。

我们可以使用以下方法使用 composer 安装发行版和预发布版（即 alpha、beta 版本）。

// Release Versions

php composer.phar create-project --prefer-dist --stability=stable cmsgears/template-basic basicdemo

or

composer create-project --prefer-dist --stability=stable cmsgears/template-basic basicdemo

我们还可以使用以下命令访问预发布代码。

// Pre-release Versions

php composer.phar create-project --prefer-dist --stability=<alpha or beta or RC> cmsgears/template-basic basicdemo

or

composer create-project --prefer-dist --stability=<alpha or beta or RC> cmsgears/template-basic basicdemo

如果 Web 服务器是 Apache，则可以直接在 Apache Web 根目录下运行上述任一命令。更多详情请参阅 http://www.cmsgears.org。

我们还可以通过克隆所选分支的基本模板，直接安装具有最新代码的模板。

一键设置

我们正在努力制作一键设置，可以避免以下步骤中列出的大部分步骤来配置模板。

模板配置

创建数据库、数据库用户并更新环境配置 - environments/dev/common/config/main-env.php、environments/alpha/common/config/main-env.php、environments/prod/common/config/main-env.php。默认数据库和数据库用户为basicdemo。
要在dev或alpha环境中触发实时邮件，请从-environments/dev/common/config/main-env.php、environments/alpha/common/config/main-env.php中删除配置参数'useFileTransport'。
配置数据库后，运行php脚本init.php初始化预定义环境的应用程序。该脚本将要求选择环境（prod、alpha或dev）。它将适当的环境文件复制到相关目录。
使用在console/migrations目录中可用的migrate-up命令安装数据库。必须从项目的根目录运行该命令。同时，确保迁移命令文件具有可执行权限。
console/migrations/data目录中提供的迁移脚本包含演示目的所需的测试数据。可以根据需求进行调整或更新。确保在更改之前执行migrate-down命令。完成后，再次执行migrate-up命令以应用更改。
根据您的Web服务器需求更新位于根目录的htaccess。有关实时应用程序设置的更多详细信息，请参阅http://www.cmsgears.org。
下载Admin和Basic主题，并将主题内容分别复制到/themes/admin和/themes/basic目录。
现在我们可以使用我们喜欢的浏览器运行模板。以下是一些示例链接。
登录到admin，并更新文件上传url，如果项目名称或上传目录不同。
默认情况下，所有用户上传的文件都将存储在uploads目录中。根据项目需求，可以更改uploads目录。
如有需要，更新迁移脚本，并运行migrate-down和migrate-up命令刷新数据库。请确保仅在dev和alpha环境中执行此操作。切勿在实时环境中运行migrate-down，否则将删除所有实时数据。

默认应用程序URL如下所示。如果已更改，请将basicdemo替换为项目名称。

Frontend - http://localhost/basicdemo/frontend/web
Admin - http://localhost/basicdemo/frontend/web

模板 - 更新

可以使用位于模板根目录的composer.json文件更新模板依赖项。

模板页面

模板包含以下列出的预配置页面。

着陆页 - 网站索引页。
登录页 - 允许用户登录。
注册页 - 允许用户注册。
确认账户 - 用户可以通过提交注册表单时发送到其电子邮件的链接来确认账户。
忘记密码 - 可以用它来生成密码重置链接。
忘记密码OTP - 可以用它来生成重置密码的OTP。如果SMS管理器可用，则它将工作。
重置密码 - 用户可以通过提交忘记密码表单时发送到其电子邮件的链接来重置密码。
重置密码OTP - 可以用它通过提供有效的OTP来重置密码。如果SMS管理器可用，则它将工作。
激活账户 - 网站管理员添加的用户可以通过此页激活账户。
隐私 - 显示隐私政策的页面。
条款 - 显示条款和条件的页面。
常见问题 - 显示常见问题的页面。

注意：只有在SMS管理器具有SMS余额的情况下，忘记密码OTP和重置密码OTP页面才会工作。

模板表单

该模板还提供使用动态表单和评论系统的表单。

联系表单（动态表单）
反馈表单（自定义评论）
评价表单（自定义评论）

私有页面

基本模板提供空白仪表板、用户资料、用户设置和日历。

仪表板 - 登录时显示的页面。
资料 - 基本资料 - 基本资料页面允许用户更新包括电子邮件、用户名、姓名、性别和出生日期在内的基本详情。
资料 - 账户 - 账户页面允许用户更新密码。
资料 - 地址 - 地址页面允许用户管理多个地址。
设置 - 设置页面允许用户配置包括隐私、通知和提醒在内的设置。
通知 - 显示用户通知。
提醒 - 显示用户提醒。
活动 - 显示用户活动。
事件 - 显示与用户关联的日历事件，使用列表视图。
事件日历 - 显示与用户关联的日历事件，使用日历视图。
事件卡片 - 显示与用户关联的日历事件，使用卡片视图。
事件 - 创建 - 创建事件页面允许用户添加日历事件。
事件 - 更新 - 创建事件页面允许用户更新日历事件。

cmsgears / template-basic

维护者

详细信息