hacklab/mapas-testes

Mapas Culturais 基础项目 - MapasDev

这是一个用于开发主题和插件的基础项目。

文件结构

• start.sh - 初始化生产/staging环境
• restart.sh - 重启生产/staging环境
• stop.sh - 停止生产/staging环境
• update.sh - 更新生产环境
• logs.sh - 显示生产环境的docker-compose输出，用于查看日志
• bash.sh - 访问Mapas容器的终端
• psql.sh - 访问数据库的psql控制台
• init-letsencrypt.sh - 辅助安装Let's Encrypt的脚本
• compose/ - docker-compose使用的配置文件及其他文件
  • common/ - 开发和生产环境共用的文件
  • local/ - 仅用于开发环境的文件
  • production/ - 仅用于生产环境的文件
• dev-scripts/ - 开发辅助脚本
  • start-dev.sh - 初始化开发环境的脚本
  • bash.sh - 进入应用容器
  • shell.sh - 进入Mapas文化的shell
  • psql.sh - 进入应用数据库
  • docker-compose.local.yml - 上述脚本使用的docker-compose定义文件
• plugins - 项目专属插件目录
  • SamplePlugin - 插件示例模板，用于演示及作为其他插件开发的基础
• themes - 项目专属主题目录
  • SampleTheme - Subsite子主题示例模板，用于演示及作为其他主题开发的基础

新项目快速入门

首先，请确保已安装git、docker和docker-compose，并使用Linux或MacOS系统。
示例中使用sudo命令以确保脚本获得docker所需的权限。

创建项目仓库

在GitHub或GitLab创建空仓库（示例使用https://github.com/organizacao/meu-mapas）。
克隆基础项目到本地：

$ git clone https://github.com/mapasculturais/mapasculturais-base-project.git meu-mapas
$ cd meu-mapas

替换远程仓库地址：

meu-mapas/$ git remote set-url origin https://github.com/organizacao/meu-mapas
# 或使用SSH密钥（若已配置）
meu-mapas/$ git remote set-url origin git@github.com:organizacao/meu-mapas

推送初始版本到仓库：

meu-mapas/$ git push
To github.com:organizacao/meu-mapas
 * [new branch]      master -> master

开发环境

启动开发环境

进入dev-scripts目录，运行start-dev.sh脚本：

mapacultural/dev-scripts/$ sudo ./start-dev.sh

在浏览器访问http://localhost/。

PsySH调试

开发环境使用PHP内置Web服务器，支持PsySH（交互式调试控制台）。在代码中添加eval(\psy\sh());即可进入控制台，按Ctrl + D继续执行代码。

停止开发环境

按Ctrl + C停止开发环境。

超级管理员账号

初始数据库包含saasSuperAdmin角色的用户：

• *******: Admin@local
• 密码: mapas123
  该用户拥有创建、修改和删除任何数据库对象的权限。

创建新主题

以主题名称NovoTema为例：

1. 复制themes/SampleTheme到themes/NovoTema：

meu-mapas/themes$ cp -a SampleTheme NovoTema

2. 编辑dev-scripts/docker-compose.yml，在volumes部分添加一行：

- ../themes/NovoTema:/var/www/html/protected/application/themes/NovoTema

3. 编辑themes/NovoTema/Theme.php，将命名空间替换为NovoTema：

php
<?php
namespace NovoTema;

创建新插件

以插件名称MeuPlugin为例：

1. 复制plugins/SamplePlugin到plugins/MeuPlugin：

meu-mapas/plugins$ cp -a SamplePlugin MeuPlugin

2. 编辑dev-scripts/docker-compose.yml，在volumes部分添加一行：

- ../plugins/MeuPlugin:/var/www/html/protected/application/plugins/MeuPlugin

3. 编辑plugins/MeuPlugin/Plugin.php，将命名空间替换为MeuPlugin：

php
<?php
namespace MeuPlugin;

生产环境

启动生产环境需基于.env_sample文件创建.env文件。