MuckRock 开源项目安装与使用指南

MuckRock 开源项目安装与使用指南

1. 项目目录结构及介绍

MuckRock 是一个基于非营利模式运行的协同新闻网站，旨在促进政府透明度与问责制。以下是该项目的主要目录结构及其简介：

• .git: Git版本控制相关文件。
• compose: Docker Compose相关的配置文件夹，包含local.yml等，用于不同环境下的部署。
• config: 应用程序配置文件夹，存放特定环境配置。
• muckrock: 主要的Django应用代码所在目录。
• pip: 管理Python依赖的工具文件夹。
• .dockerignore, .gitignore: 分别指示Docker和Git忽略哪些文件。
• LICENSE: 许可证文件，MuckRock遵循AGPL-3.0协议。
• README.md: 项目介绍和快速入门文档。
• requirements.txt: Python基础依赖列表。
• tasks.py: 定义了一系列方便开发的Invoke任务。

项目的核心在于muckrock目录，包含了Django应用程序的核心逻辑，而config目录则存储了根据不同环境（如开发、生产）调整的配置文件。

2. 项目启动文件介绍

• 主要启动脚本是通过invoke命令管理的，而非直接执行某个单一文件。尤其关注的是inv up命令，它使用Docker Compose来构建并启动项目所需的所有容器，包括Django服务器、数据库(PostgreSQL)、消息队列(Redis)，以及Celery任务处理器等。

• 对于Django开发者来说，实际的服务启动关键在于manage.py，位于muckrock目录下，但通常不直接由开发者手动调用，而是通过Invoke的任务如inv runserver间接执行。

3. 项目配置文件介绍

• 环境变量配置是通过环境变量实现的，初始化这些变量的脚本是initialize_dotenvs.py。重要配置项分散在多个地方，例如Django设置中的DJANGO_SETTINGS_MODULE通常在环境中指定，而特定服务配置可能存储在.env文件或专门的配置目录中。

• 环境特异性配置通常放在envs/local/django等路径下，比如需设置SQUARELET_KEY和SQUARELET_SECRET以连接到Squarelet进行用户认证。

• Docker Compose配置(local.yml)也是关键配置之一，定义了各个服务的启动参数、网络配置及依赖关系。

• 其他配置如Python依赖管理和测试配置分别在requirements.txt, dev-requirements.txt和相应的Invoke任务中体现。

通过以上说明，您可以了解到MuckRock项目的基本结构，启动流程和核心配置方式，进而更顺利地进行开发或部署工作。记住，在开始之前务必确保已正确设置环境，并熟悉Docker和Invoke工具的使用。