hacklab/mapas-pa

巴西文化地图（帕拉州文化地图）

巴西文化地图项目的部署仓库，用于支持文化地图应用的开发、部署及扩展，提供完整的开发环境配置、主题和插件开发框架。

文件结构

• compose

  • common - 开发和生产环境的通用配置文件
  • local - 仅用于开发环境的配置文件
  • production - 仅用于生产环境的配置文件

• dev-scripts - 辅助开发的脚本工具

  • start-dev.sh - 初始化开发环境的脚本
  • bash.sh - 进入应用容器的脚本
  • shell.sh - 进入文化地图shell的脚本
  • psql.sh - 进入应用数据库的脚本
  • docker-compose.local.yml - 上述脚本使用的docker-compose定义文件

• plugins - 项目专属插件开发目录

  • SamplePlugin - 插件骨架，用于演示及作为其他插件开发的基础

• themes - 项目专属主题开发目录

  • SampleTheme - Subsite子主题骨架，用于演示及作为其他主题开发的基础

新项目快速入门指南

前置条件

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

创建项目仓库

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

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

3. 将远程仓库地址替换为新建仓库：

   bash
   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
   

4. 推送初始版本到远程仓库：

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

开发环境操作

启动开发环境

进入dev-scripts目录并运行启动脚本：

bash
meu-mapas/dev-scripts/$ sudo ./start-dev.php

在浏览器中访问 http://localhost/ 即可使用。

PsySH 交互式控制台

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

停止开发环境

使用 Ctrl + C 停止开发环境。

网络超级管理员账户

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

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

创建新主题

以主题名称 NovoTema 为例：

1. 复制SampleTheme骨架到新主题目录：

   bash
   meu-mapas/themes$ cp -a SampleTheme NovoTema
   

2. 编辑 dev-scripts/docker-compose.yml，在volumes部分添加主题挂载配置：

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

3. 编辑 themes/NovoTema/Theme.php，将命名空间（第2行）替换为 NovoTema：

   php
   <?php
   namespace NovoTema;
   

创建新插件

以插件名称 MeuPlugin 为例：

1. 复制SamplePlugin骨架到新插件目录：

   bash
   meu-mapas/plugins$ cp -a SamplePlugin MeuPlugin
   

2. 编辑 dev-scripts/docker-compose.yml，在volumes部分添加插件挂载配置：

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

3. 编辑 plugins/MeuPlugin/Plugin.php，将命名空间（第2行）替换为 MeuPlugin：

   php
   <?php
   namespace MeuPlugin;