如何零基础上手FixMyStreet:新手友好的3人团队快速启动指南
如何零基础上手FixMyStreet:新手友好的3人团队快速启动指南
FixMyStreet 是 mySociety 出品的开源地图式街道问题上报平台:市民在地图上打个点,报告会自动转发给对应的负责部门。本文面向零基础新手,带你用 3 人小团队的分工方式,快速完成从安装、验证到上线后的配置。
1分钟了解 FixMyStreet 能做什么 🗺️
官方文档 docs/how-it-works.md 概括了它的核心能力:
- 自动分发:根据问题位置和类别(category),自动判断应由哪个部门处理,通过邮件或 Open311 等服务发送报告
- 公开透明:所有报告对公众可见,可留评论、更新进度
- 防重复:附近已有同类报告时会提示用户,避免重复上报
- 订阅提醒:用户可订阅所在区域的邮件或 RSS 提醒
它自 2007 年起在英国稳定运行,已被全球多个国家和本地区复制部署,当前版本为 6.0(见 CHANGELOG.md)。
3人团队怎么分工?
官方推荐的最小团队只有 3 个角色(见 docs/how-it-works.md):
| 角色 | 负责什么 | 需要的技能 |
|---|---|---|
| 管理员(administrator) | 运营站点、对接政府部门、用户支持 | 沟通与组织 |
| 开发者(developer) | 安装软件、定制外观与行为 | 基础命令行与代码能力 |
| 翻译(translator) | 界面本地化(若使用官方已有语言可省略) | 无需编程经验 |
📌 官方强烈建议先通读这份免费 PDF 指南再动手:The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf,它解释了这类网站为什么有效、启动前要考虑什么。
最快启动方式:用 Docker 一条命令跑起来 ⚡
安装方式共有 6 种(Docker、安装脚本、Amazon EC2 AMI、Vagrant、手动安装等),完整列表见 docs/install/index.md。
对新手最友好的是 Docker 开发模式,文档:docs/install/docker-develop.md:
-
克隆代码仓库:
git clone https://gitcode.com/gh_mirrors/fi/fixmystreet -
进入仓库目录后执行:
docker/compose-dev up该命令会自动拉起应用、数据库(PostgreSQL)、memcached 和 Web 服务器四个容器。首次启动时间较长,可在另一个终端执行
docker logs docker_setup_1 -f观察进度。 -
启动完成后在浏览器访问本地地址,即可看到可正常使用的 FixMyStreet 站点。
💡 若计划部署到正式服务器,可参考 docs/install/install-script.md(Debian/Ubuntu 一键脚本)或 docs/install/ami.md(AWS 镜像)。
验证安装成功:跑一遍测试套件 ✅
FixMyStreet 自带完整的测试体系,是新手学习项目结构的好入口(详见 docs/install/testing.md):
script/test
- 后端测试:在仓库根目录运行
script/test,master分支应保持全部通过 - 前端测试:通过
npm install cypress安装 Cypress 后,运行bin/browser-tests run
开发常用脚本(采用 "Scripts to Rule Them All" 约定,见 README.md):
- script/server:启动本地开发服务器
- script/update:更新代码检出
- script/test:运行测试
上线前必做的 3 项配置 🔧
站点跑起来只是开始。官方定制清单在 docs/customising/checklist.md,最关键的三件事:
1. 创建你的 cobrand(品牌定制)
cobrand 是 FixMyStreet 的定制机制:通过一组模板、CSS 和可选的 Perl 模块覆盖默认外观,而不修改原始文件——这样升级时不会覆盖你的改动。机制说明见 docs/customising/cobrand-module.md。
2. 准备区域数据
需要覆盖区域的边界数据(含内部各行政区边界),说明见 docs/customising/boundaries.md。官方建议:先从小范围开始(比如一个城市),运转良好后再扩展。
3. 收集各部门联系邮箱
为每个问题类别、每个责任部门找到接收报告的邮箱地址,整理方法见 docs/running/bodies_and_contacts.md。这是"报告能真正被处理"的关键一环。
日常配置主要通过 conf/general.yml 文件完成,可参考仓库中的示例 conf/general.yml-example。
上线后:使用管理后台
管理员通过 /admin 路径进入后台,可管理 Body(责任机构)、Reports(报告)、Templates(回复模板)、Users(用户)等。官方安装文档 docs/install/install-script.md 中介绍了用 createsuperuser 命令创建超级用户的方法。运营阶段的完整手册见 docs/running/index.md。
延伸阅读:按角色找到你的文档 📚
| 你想做的事 | 文档位置 |
|---|---|
| 安装与部署 | docs/install/index.md |
| 定制外观、语言、地图 | docs/customising/index.md |
| 日常运营与用户支持 | docs/running/index.md |
| 排查安装问题 | docs/install/troubleshooting.md |
| 术语表 | docs/glossary.md |
🎉 总结:按"组建 3 人团队 → Docker 一键安装 → 跑通测试 → 配置 cobrand/区域/邮箱 → 上线运营"五步走,即使是零基础团队,也能在几周内让 FixMyStreet 在你的地区落地运行。记住官方那句忠告:设置站点只是开始,长期投入才能让它成功。


