Orbit 项目安装与使用教程

Orbit 项目安装与使用教程

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

Orbit 项目的目录结构如下：

orbit/

├── orbit-app/

│ ├── public/

│ ├── src/

│ ├── .env.local

│ ├── package.json

│ └── README.md

├── orbit-api/

│ ├── config/

│ ├── controllers/

│ ├── models/

│ ├── routes/

│ ├── .env.example

│ ├── package.json

│ └── README.md

├── .gitignore

├── LICENSE

└── README.md

目录结构介绍

orbit-app/: 前端 React 应用程序的根目录。

public/: 包含静态文件，如 HTML 文件和图标。src/: 包含 React 应用程序的源代码。.env.local: 前端的环境配置文件，包含 REACT_APP_API_URL 变量。package.json: 前端项目的依赖和脚本配置文件。README.md: 前端项目的说明文档。

orbit-api/: 后端 Node.js API 的根目录。

config/: 包含 API 的配置文件。controllers/: 包含 API 的控制器文件。models/: 包含 API 的数据模型文件。routes/: 包含 API 的路由文件。.env.example: 后端的环境配置文件模板，需要重命名为 .env 并填写相关配置。package.json: 后端项目的依赖和脚本配置文件。README.md: 后端项目的说明文档。

.gitignore: Git 忽略文件列表。

LICENSE: 项目的开源许可证文件。

README.md: 项目的总体说明文档。

2. 项目的启动文件介绍

前端启动文件

前端 React 应用程序的启动文件是 orbit-app/src/index.js。这个文件是 React 应用程序的入口点，负责渲染应用程序到 HTML 页面中。

后端启动文件

后端 Node.js API 的启动文件是 orbit-api/index.js。这个文件是 API 的入口点，负责启动服务器并监听指定的端口。

3. 项目的配置文件介绍

前端配置文件

前端的配置文件是 orbit-app/.env.local。这个文件包含一个环境变量 REACT_APP_API_URL，用于指定后端 API 的 URL。

后端配置文件

后端的配置文件模板是 orbit-api/.env.example。这个文件需要重命名为 .env 并填写以下配置：

ATLAS_URL: MongoDB Atlas 集群的连接字符串。JWT_SECRET: 用于生成和验证 JWT 的密钥。

配置文件示例：

ATLAS_URL=mongodb+srv://:@cluster0.mongodb.net/myFirstDatabase?retryWrites=true&w=majority

JWT_SECRET=your_jwt_secret_here

请根据实际情况填写这些配置。