Micro-Livraria 项目使用教程
1. 项目的目录结构及介绍
Micro-Livraria 项目是一个使用微服务架构实现的虚拟书店示例。项目的目录结构如下:
micro-livraria/
├── cypress/
├── proto/
├── services/
├── .editorconfig
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
目录结构介绍
- cypress/: 包含 Cypress 测试框架的配置和测试文件。
- proto/: 包含 gRPC 协议的
.proto
文件,定义了微服务的接口和消息格式。 - services/: 包含各个微服务的实现代码,如
controller
、shipping
和inventory
等。 - .editorconfig: 编辑器配置文件,用于统一代码风格。
- .gitignore: Git 忽略文件配置,指定哪些文件或目录不需要被 Git 管理。
- .prettierrc: Prettier 代码格式化配置文件。
- LICENSE: 项目的开源许可证文件。
- README.md: 项目的说明文档。
- package-lock.json: 锁定项目依赖包的版本。
- package.json: 项目的配置文件,包含项目的依赖、脚本等信息。
2. 项目的启动文件介绍
项目的启动文件主要集中在 package.json
文件中,通过 npm
命令来启动各个微服务。
package.json
文件中的启动脚本
{
"scripts": {
"start": "node services/controller/index.js & node services/shipping/index.js & node services/inventory/index.js & node services/frontend/index.js"
}
}
启动命令
在项目根目录下执行以下命令启动所有微服务:
npm run start
3. 项目的配置文件介绍
package.json
package.json
是 Node.js 项目的核心配置文件,包含了项目的元数据、依赖包、脚本等信息。
{
"name": "micro-livraria",
"version": "1.0.0",
"description": "Exemplo prático de uma pequena livraria virtual implementada usando microsserviços",
"main": "index.js",
"scripts": {
"start": "node services/controller/index.js & node services/shipping/index.js & node services/inventory/index.js & node services/frontend/index.js"
},
"dependencies": {
"express": "^4.17.1",
"grpc": "^1.24.4",
"node-fetch": "^2.6.1"
},
"devDependencies": {
"cypress": "^6.0.0"
}
}
配置文件介绍
- name: 项目的名称。
- version: 项目的版本号。
- description: 项目的描述。
- main: 项目的入口文件。
- scripts: 定义了项目的脚本命令,如
start
命令用于启动所有微服务。 - dependencies: 项目运行时所需的依赖包。
- devDependencies: 开发环境所需的依赖包。
通过以上配置文件和启动命令,可以方便地启动和管理 Micro-Livraria 项目中的各个微服务。