Bedrock-Core 项目教程

Bedrock-Core 项目教程

bedrock-coreBedrock is a battle-tested template of micro services, components and patterns that tie together Kubernetes, Mongo, Node and React项目地址:https://gitcode.com/gh_mirrors/be/bedrock-core

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

Bedrock-Core 项目的目录结构如下：

bedrock-core/
├── deployment/
│   └── ...
├── services/
│   ├── api/
│   └── web/
├── github/workflows/
│   └── ...
├── .editorconfig
├── .env
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── docker-compose.yml

目录结构介绍

• deployment/: 包含项目的部署相关文件和配置。
• services/: 包含项目的核心服务，分为 api 和 web 两个子目录。
  • api/: 数据 API 和数据模型层，为所有应用程序提供数据支持。
  • web/: 包含 Web 应用程序和管理仪表盘。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• docker-compose.yml: Docker Compose 配置文件，用于本地开发和测试。

2. 项目的启动文件介绍

Bedrock-Core 项目的主要启动文件位于 services/ 目录下。

services/api/

• index.js: API 服务的主入口文件，负责启动 API 服务。
• server.js: 包含服务器的配置和启动逻辑。

services/web/

• index.js: Web 应用程序的主入口文件，负责启动 Web 服务。
• server.js: 包含服务器的配置和启动逻辑。

3. 项目的配置文件介绍

.env

.env 文件用于配置项目的环境变量，例如数据库连接字符串、端口号等。

# 数据库连接字符串
MONGO_URI=mongodb://localhost:27017/bedrock

# API 服务端口
API_PORT=3000

# Web 服务端口
WEB_PORT=2200

docker-compose.yml

docker-compose.yml 文件用于定义 Docker 容器的配置，方便本地开发和测试。

version: '3.8'
services:
  api:
    build: ./services/api
    ports:
      - "3000:3000"
    environment:
      - MONGO_URI=mongodb://mongo:27017/bedrock
    depends_on:
      - mongo

  web:
    build: ./services/web
    ports:
      - "2200:2200"
    environment:
      - API_URL=http://api:3000
    depends_on:
      - api

  mongo:
    image: mongo:latest
    ports:
      - "27017:27017"

.editorconfig

.editorconfig 文件用于统一不同编辑器和 IDE 的代码风格。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

通过以上配置，可以确保项目在不同开发环境中的代码风格一致。

bedrock-coreBedrock is a battle-tested template of micro services, components and patterns that tie together Kubernetes, Mongo, Node and React项目地址:https://gitcode.com/gh_mirrors/be/bedrock-core