Mathesar项目使用教程

Mathesar项目使用教程

mathesar An intuitive spreadsheet-like interface that lets users of all technical skill levels view, edit, query, and collaborate on Postgres data directly—100% open source and self hosted, with native Postgres access control. 项目地址: https://gitcode.com/gh_mirrors/ma/mathesar

1. 项目的目录结构及介绍

Mathesar项目是一个开源的数据管理平台，其目录结构如下：

mathesar/
├── .github/                # GitHub特定的配置文件
├── .tx/                    # 翻译相关文件
├── LICENSES/               # 许可证文件
├── api_tests/              # API测试用例
├── config/                 # 配置文件
├── db/                     # 数据库相关文件
├── docs/                   # 文档资料
├── mathesar/               # Mathesar核心代码
├── mathesar_ui/            # Mathesar用户界面代码
├── translations/           # 国际化翻译文件
├── .dockerignore           # Docker构建忽略文件
├── .env.example            # 环境变量示例文件
├── .flake8                 # Python linter配置文件
├── .gitignore              # Git忽略文件
├── CONTRIBUTING.md         # 贡献指南
├── Caddyfile               # Caddy配置文件
├── DEVELOPER_GUIDE.md      # 开发者指南
├── Dockerfile              # Docker构建文件
├── Dockerfile.caddy        # Caddy用的Docker构建文件
├── Dockerfile.devdb        # 开发数据库的Docker构建文件
├── LICENSE                 # 许可证文件
├── README.md               # 项目说明文件
├── THIRDPARTY              # 第三方依赖许可文件
├── TROUBLESHOOTING.md      # 故障排除指南
├── conftest.py             # 测试配置文件
├── db-run.sh               # 数据库运行脚本
├── dev-run.sh              # 开发环境运行脚本
├── docker-compose.dev.yml  # Docker开发环境配置文件
├── docker-compose.test.yml # Docker测试环境配置文件
├── docker-compose.yml      # Docker生产环境配置文件
├── lint.sh                 # 代码检查脚本
├── manage.py               # Django管理脚本
├── pyproject.toml          # Python项目配置文件
├── requirements-dev.txt    # 开发环境依赖文件
├── requirements.txt        # 生产环境依赖文件
├── run.sh                  # 运行脚本
├── run_api_tests.sh        # 运行API测试脚本
├── run_pytest.sh           # 运行Pytest测试脚本
├── setup.cfg               # 设置配置文件
└── ...

• .github/：包含GitHub Actions的工作流文件和其他GitHub特定的配置文件。
• .tx/：包含翻译相关文件，用于支持项目国际化。
• LICENSES/：包含项目的许可证文件，本项目采用GPLv3许可证。
• api_tests/：包含针对API的测试用例，用于确保API的功能正常。
• config/：包含项目的配置文件，用于设置项目运行参数。
• db/：包含数据库相关的迁移文件和脚本。
• docs/：包含项目文档资料。
• mathesar/：包含Mathesar的核心代码，包括业务逻辑和模型。
• mathesar_ui/：包含Mathesar的用户界面代码，使用Svelte构建。
• translations/：包含Mathesar的国际化翻译文件。
• 其他文件和目录包含了项目的启动脚本、环境配置、构建脚本和文档。

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• manage.py：Django管理脚本，用于运行数据库迁移、创建管理员账号等。
• run.sh：运行脚本，用于启动Mathesar服务。
• docker-compose.yml：Docker编排文件，定义了服务、网络和卷，用于启动Mathesar容器。

以运行Docker容器为例，你可以在项目根目录下执行以下命令启动Mathesar服务：

docker-compose up

这会根据docker-compose.yml文件中定义的服务启动Mathesar的容器。

3. 项目的配置文件介绍

Mathesar项目的配置主要通过以下文件进行：

• .env.example：环境变量示例文件，包含所有需要设置的环境变量及其默认值。
• config/：包含具体的配置文件，例如config.py。

在.env.example文件中，你可以找到如下配置项：

# Mathesar environment variables
DEBUG=off
SECRET_KEY=your_secret_key
DATABASE_URL=postgres://user:password@localhost:5432/mathesar
# ... 其他配置项

你需要根据实际情况创建一个.env文件，并设置相应的环境变量。manage.py和其他脚本会读取这些环境变量以配置Mathesar服务。

mathesar An intuitive spreadsheet-like interface that lets users of all technical skill levels view, edit, query, and collaborate on Postgres data directly—100% open source and self hosted, with native Postgres access control. 项目地址: https://gitcode.com/gh_mirrors/ma/mathesar