source[d] Community Edition (CE) 项目教程

source[d] Community Edition (CE) 项目教程

sourced-ce source{d} Community Edition (CE) 项目地址: https://gitcode.com/gh_mirrors/so/sourced-ce

1. 项目目录结构及介绍

src-d/sourced-ce/
├── cmd/
│   └── sourced/
│       └── sourced
├── docs/
│   ├── learn-more/
│   │   └── architecture.md
│   └── ...
├── test/
│   └── ...
├── .gitbook.yaml
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── DCO
├── LICENSE.md
├── MAINTAINERS
├── Makefile
├── NOTICE.md
├── README.md
├── docker-compose.yml
├── go.mod
├── go.sum
└── run-integration-tests.bat

目录结构介绍

• cmd/: 包含项目的命令行工具 sourced 的源代码。
• docs/: 包含项目的文档，包括架构文档 architecture.md。
• test/: 包含项目的测试代码。
• .gitbook.yaml: GitBook 配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目变更日志。
• DCO: 开发者证书配置文件。
• LICENSE.md: 项目许可证文件。
• MAINTAINERS: 项目维护者列表。
• Makefile: 项目构建文件。
• NOTICE.md: 项目通知文件。
• README.md: 项目介绍文件。
• docker-compose.yml: Docker Compose 配置文件，用于启动项目。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块依赖校验文件。
• run-integration-tests.bat: 集成测试脚本。

2. 项目启动文件介绍

启动文件

• cmd/sourced/sourced: 这是项目的命令行工具，用于初始化和运行 source[d] CE。

启动命令

$ sourced init orgs --token=<github_token> <github_org_name>

启动步骤

1. 安装 Docker。
2. 从项目的 releases 页面下载适用于你操作系统的 sourced 二进制文件。
3. 运行上述启动命令。
4. 访问 http://127.0.0.1:8088，使用用户名 admin 和密码 admin 登录。

3. 项目配置文件介绍

配置文件

• docker-compose.yml: 这是 Docker Compose 的配置文件，定义了项目的各个服务及其配置。

配置文件内容

version: '3'
services:
  sourced-ui:
    image: sourced/sourced-ui:latest
    ports:
      - "8088:8088"
    depends_on:
      - gitbase
      - ghsync
      - gitcollector
      - babelfish
  gitbase:
    image: sourced/gitbase:latest
    volumes:
      - git-repositories:/var/opt/git
  ghsync:
    image: sourced/ghsync:latest
    environment:
      - GITHUB_TOKEN=<your_github_token>
  gitcollector:
    image: sourced/gitcollector:latest
    environment:
      - GITHUB_TOKEN=<your_github_token>
  babelfish:
    image: sourced/babelfish:latest
volumes:
  git-repositories:

配置文件说明

• sourced-ui: 项目的 Web 界面服务，端口映射为 8088。
• gitbase: 用于处理 Git 仓库的 SQL 数据库接口服务。
• ghsync: 用于从 GitHub 同步元数据的服务。
• gitcollector: 用于收集 Git 仓库的服务。
• babelfish: 用于解析代码的通用代码解析器服务。
• volumes: 定义了 Docker 卷 git-repositories，用于存储 Git 仓库数据。

通过以上配置文件，项目可以自动启动并运行各个服务，提供代码管理和分析功能。

sourced-ce source{d} Community Edition (CE) 项目地址: https://gitcode.com/gh_mirrors/so/sourced-ce