CJWorkbench 开源项目启动与配置教程

CJWorkbench 开源项目启动与配置教程

cjworkbench The data journalism platform with built in training 项目地址: https://gitcode.com/gh_mirrors/cj/cjworkbench

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

CJWorkbench 是一个开源的数据新闻平台，其目录结构如下：

cjworkbench/
├── .gcloudignore
├── .gitignore
├── .tern-project
├── .watchmanconfig
├── Dockerfile
├── Dockerfile.integration-test
├── LICENSE
├── README.md
├── _deprecated_i18n_messages.py
├── babel.config.json
├── cloudbuild.yaml
├── docker-bake.hcl
├── docker-compose.commands.yml
├── docker-compose.yml
├── lingui.config.js
├── manage.py
├── package-lock.json
├── package.json
├── pybabel.cfg
├── pyproject.toml
├── setupJest.js
├── webpack.config.js
├── assets/
├── bin/
├── cjwkernel/
├── cjworkbench/
├── cjwstate/
├── cron/
├── daphne/
├── doc/
├── docker/
├── fetcher/
├── flyway/
├── integrationtests/
├── renderer/
├── server/
├── staticfilesdev/
├── templates/
├── tusdhooks/
├── venv/
└── ...

主要目录和文件介绍：

• assets/：存放静态资源，如图片、样式表等。
• bin/：包含可执行脚本。
• cjwkernel/：核心模块，处理数据操作和逻辑。
• cjworkbench/：项目的主要应用模块。
• cjwstate/：状态管理模块。
• cron/：定时任务脚本。
• daphne/：用于WebSocket通信。
• doc/：存放项目文档。
• docker/：Docker相关配置文件。
• fetcher/：数据抓取模块。
• flyway/：数据库迁移工具。
• integrationtests/：集成测试模块。
• renderer/：渲染模块，用于生成页面。
• server/：服务器配置和启动脚本。
• staticfilesdev/：开发环境下的静态文件管理。
• templates/：HTML模板文件。
• tusdhooks/：用于处理文件上传的钩子。
• venv/：虚拟环境目录。

2. 项目的启动文件介绍

项目的启动文件主要包括以下两个：

• manage.py：Django项目的管理脚本，用于运行服务器、执行数据库迁移等操作。
• docker-compose.yml：定义了Docker服务的配置，包括数据库、Web服务器等。

启动项目的基本命令如下：

# 进入项目目录
cd path/to/cjworkbench

# 运行Django开发服务器
python manage.py runserver

使用Docker启动的命令如下：

# 构建Docker镜像
docker-compose build

# 运行Docker服务
docker-compose up

3. 项目的配置文件介绍

项目的配置文件主要包括以下两个：

• settings.py：Django项目的配置文件，包含数据库设置、静态文件设置等。
• docker-compose.yml：Docker服务的配置文件，定义了各个服务容器的配置。

在 settings.py 中，可以配置数据库连接、静态文件存储位置等关键设置。例如：

# settings.py 中的数据库配置示例
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'your_db_name',
        'USER': 'your_db_user',
        'PASSWORD': 'your_db_password',
        'HOST': 'localhost',
        'PORT': '5432',
    }
}

在 docker-compose.yml 中，可以定义服务的环境变量、卷映射、网络等。例如：

version: '3.8'
services:
  db:
    image: postgres:12
    volumes:
      - db_data:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: your_db_name
      POSTGRES_USER: your_db_user
      POSTGRES_PASSWORD: your_db_password
  web:
    build: .
    command: python manage.py runserver 0.0.0.0:8000
    volumes:
      - .:/code
    ports:
      - "8000:8000"
    depends_on:
      - db
volumes:
  db_data:

以上是CJWorkbench开源项目的启动和配置基本教程，希望对您有所帮助。

cjworkbench The data journalism platform with built in training 项目地址: https://gitcode.com/gh_mirrors/cj/cjworkbench