GRANDstack Starter 项目教程

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

grand-stack-starter/
├── api/
│   ├── src/
│   ├── package.json
│   ├── .env
│   └── ...
├── web/
│   ├── src/
│   ├── package.json
│   └── ...
├── .eslintrc.json
├── .prettierrc.json
├── package.json
├── README.md
└── ...

目录结构说明

• api/: 包含 GraphQL API 应用程序的代码和配置文件。

  • src/: 存放 API 的主要源代码。
  • package.json: 定义 API 项目的依赖和脚本。
  • .env: 用于设置环境变量，包含凭证和配置选项。

• web/: 包含前端 Web 应用程序的代码和配置文件。

  • src/: 存放前端应用的主要源代码。
  • package.json: 定义前端项目的依赖和脚本。

• .eslintrc.json: 用于代码检查的 ESLint 配置文件。

• .prettierrc.json: 用于代码格式化的 Prettier 配置文件。

• package.json: 定义整个项目的依赖和脚本。

• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

API 启动文件

在 api/ 目录下，主要的启动文件是 src/index.js 或 src/index.ts，具体取决于项目使用的编程语言。这个文件负责启动 Apollo Server 并连接到 Neo4j 数据库。

Web 启动文件

在 web/ 目录下，主要的启动文件通常是 src/index.js 或 src/index.tsx，具体取决于项目使用的编程语言。这个文件负责启动 React 或 Angular 应用。

3. 项目的配置文件介绍

.env 文件

位于 api/ 目录下，用于设置环境变量，包含凭证和配置选项。例如：

NEO4J_URI=bolt://localhost:7687
NEO4J_USER=neo4j
NEO4J_PASSWORD=password

package.json 文件

位于项目根目录和 api/、web/ 子目录下，定义了项目的依赖和脚本。例如：

{
  "name": "grand-stack-starter",
  "version": "1.0.0",
  "scripts": {
    "start": "npm run start --prefix api & npm run start --prefix web"
  },
  "dependencies": {
    "apollo-server": "^3.0.0",
    "react": "^17.0.0"
  }
}

.eslintrc.json 文件

用于代码检查的 ESLint 配置文件，位于项目根目录下。例如：

{
  "extends": "eslint:recommended",
  "rules": {
    "no-console": "off"
  }
}

.prettierrc.json 文件

用于代码格式化的 Prettier 配置文件，位于项目根目录下。例如：

{
  "singleQuote": true,
  "trailingComma": "all"
}

通过以上配置文件和目录结构，您可以快速了解和启动 GRANDstack Starter 项目。