Green Cost Explorer 项目启动与配置教程

1. 项目目录结构及介绍

Green Cost Explorer 的目录结构如下：

green-cost-explorer/
├── bin/                       # 存放可执行脚本
├── data/                      # 存储项目数据
├── src/                       # 源代码目录
│   ├── .all-contributorsrc    # all-contributors 规则配置文件
│   ├── .gitignore             # git 忽略文件配置
│   ├── AWS-Regions.png        # AWS 区域分布图
│   ├── LICENSE                # 项目许可证文件
│   ├── NOTICE                 # 项目通知文件
│   ├── README.md              # 项目说明文件
│   ├── package-lock.json       # npm 包锁定文件
│   └── package.json           # npm 包配置文件

• bin/ 目录包含用于运行项目的脚本文件。
• data/ 目录用来存放项目运行过程中生成的数据文件。
• src/ 目录包含项目的所有源代码和配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 bin/ 目录下的脚本实现的。以下是启动项目的常见方式：

npx @tgwf/green-cost-explorer

或者，如果你已经将项目链接到本地，可以使用以下命令：

npx greencost

执行这些命令后，项目将根据预设的配置文件开始运行，展示AWS费用在绿色能源和灰色能源上的分布情况。

3. 项目的配置文件介绍

项目的配置主要通过 src/ 目录下的 package.json 文件进行。以下是 package.json 文件的一些基本配置：

{
  "name": "green-cost-explorer",
  "version": "1.0.0",
  "description": "climate related spend analysis for AWS",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  // 其他配置...
}

在 scripts 部分，你可以定义不同的命令来启动或运行项目。例如，"start": "node index.js" 定义了使用Node.js运行 index.js 文件来启动项目。

此外，项目可能还需要AWS凭证配置才能访问AWS服务。通常情况下，这些凭证可以通过环境变量来设置，如下所示：

export AWS_ACCESS_KEY_ID='YOUR_KEY_ID'
export AWS_SECRET_ACCESS_KEY='YOUR_SECRET_ACCESS_KEY'

确保在运行项目之前正确配置了这些凭证。