Django Report Builder 项目教程

Django Report Builder 项目教程

django-report-builder This is a github mirror for django-report-builder which is hosted on Gitlab. Django Report Builder is a GUI for Django ORM. Build custom queries and display results. Targets sys admins and capable end users who might not be able to program. 项目地址: https://gitcode.com/gh_mirrors/dj/django-report-builder

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

Django Report Builder 项目的目录结构如下：

django-report-builder/
├── docs/
├── js/
├── report_builder/
├── report_builder_demo/
├── report_builder_scheduled/
├── .dockerignore
├── .gitignore
├── .gitlab-ci.yml
├── CHANGELOG
├── Dockerfile
├── LICENSE
├── MANIFEST.in
├── README.md
├── build_js.sh
├── docker-compose.yml
├── manage.py
├── mkdocs.yml
├── poetry.lock
├── pyproject.toml
├── setup.cfg
├── setup.py
├── tox.ini
├── tox.py37.ini
├── tox.py38.ini

目录结构介绍

• docs/: 存放项目的文档文件。
• js/: 存放前端相关的 JavaScript 文件。
• report_builder/: 核心代码目录，包含 Django Report Builder 的主要功能实现。
• report_builder_demo/: 存放演示项目的代码。
• report_builder_scheduled/: 存放定时任务相关的代码。
• .dockerignore: Docker 忽略文件。
• .gitignore: Git 忽略文件。
• .gitlab-ci.yml: GitLab CI 配置文件。
• CHANGELOG: 项目更新日志。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• MANIFEST.in: Python 包清单文件。
• README.md: 项目介绍和使用说明。
• build_js.sh: 构建 JavaScript 的脚本。
• docker-compose.yml: Docker Compose 配置文件。
• manage.py: Django 项目管理脚本。
• mkdocs.yml: MkDocs 配置文件。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。
• setup.cfg: Python 包配置文件。
• setup.py: Python 包安装脚本。
• tox.ini: Tox 配置文件。
• tox.py37.ini: Python 3.7 的 Tox 配置文件。
• tox.py38.ini: Python 3.8 的 Tox 配置文件。

2. 项目的启动文件介绍

manage.py

manage.py 是 Django 项目的管理脚本，用于执行各种管理任务，如启动开发服务器、运行迁移、创建超级用户等。

python manage.py runserver

build_js.sh

build_js.sh 是一个用于构建前端 JavaScript 文件的脚本。通常在开发过程中使用。

./build_js.sh

3. 项目的配置文件介绍

docker-compose.yml

docker-compose.yml 是 Docker Compose 的配置文件，用于定义和运行多容器 Docker 应用程序。

version: '3'
services:
  web:
    build: .
    command: python manage.py runserver 0.0.0.0:8000
    volumes:
      - .:/code
    ports:
      - "8000:8000"

pyproject.toml

pyproject.toml 是 Poetry 项目的配置文件，用于管理项目的依赖和构建系统。

[tool.poetry]
name = "django-report-builder"
version = "0.1.0"
description = "A GUI for Django ORM"
authors = ["Your Name <you@example.com>"]

[tool.poetry.dependencies]
python = "^3.7"
django = "^3.0"

[tool.poetry.dev-dependencies]
pytest = "^5.2"

mkdocs.yml

mkdocs.yml 是 MkDocs 的配置文件，用于生成项目的文档网站。

site_name: Django Report Builder Documentation
nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Configuration: configuration.md

通过以上配置文件，可以方便地启动和管理 Django Report Builder 项目。

django-report-builder This is a github mirror for django-report-builder which is hosted on Gitlab. Django Report Builder is a GUI for Django ORM. Build custom queries and display results. Targets sys admins and capable end users who might not be able to program. 项目地址: https://gitcode.com/gh_mirrors/dj/django-report-builder