Star 项目使用教程

Star 项目使用教程

star A STock Analysis and Research tool for terminal(cli) users. 技术控和命令行爱好者的 A 股辅助分析工具。 项目地址: https://gitcode.com/gh_mirrors/star9/star

1. 项目目录结构及介绍

Star项目的目录结构如下：

star/
├── bin/
├── lib/
├── snapshot/
├── .gitignore
├── .npmignore
├── FAQ.md
├── Gulpfile.js
├── LICENSE
├── README.md
├── eslint.json
├── history.md
├── package.json
├── star.js
├── symbols.yaml
├── yarn.lock

• bin/：存放可执行文件。
• lib/：包含项目的库文件。
• snapshot/：用于存放项目快照文件。
• .gitignore：定义Git忽略的文件。
• .npmignore：定义npm打包时忽略的文件。
• FAQ.md：常见问题解答文档。
• Gulpfile.js：Gulp配置文件。
• LICENSE：项目许可证文件。
• README.md：项目说明文档。
• eslint.json：ESLint配置文件。
• history.md：项目历史变更记录。
• package.json：Node.js项目配置文件。
• star.js：项目主文件。
• symbols.yaml：股票数据配置文件。
• yarn.lock：Yarn依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件是star.js，它是项目的主入口。在这个文件中，定义了项目的核心逻辑，包括股票追踪、数据查询、财经日历等功能。运行以下命令可以启动项目：

node star.js

在第一次运行时，可能需要指定股票数据文件，使用以下命令：

node star.js -f /path/to/symbols.yaml

3. 项目的配置文件介绍

项目的配置文件主要包括symbols.yaml和.npmignore。

• symbols.yaml：股票数据文件，采用YAML格式。在这个文件中，可以配置股票的名称、代码、买点价位、卖点价位、目标价位、星级、是否持有、是否关注、备注等信息。

  示例配置：

  - name: '掌趣科技'
    code: '300315'
    cheap: 16
    expensive: 22
    target: 23
    star: 3
    hold: false
    watch: true
    comment: '手游;高送转;自设目标'
  

• .npmignore：定义了在执行npm pack命令时，应该被忽略的文件和目录。这对于打包发布项目时防止敏感文件或不需要的文件被包含在内非常有用。

star A STock Analysis and Research tool for terminal(cli) users. 技术控和命令行爱好者的 A 股辅助分析工具。 项目地址: https://gitcode.com/gh_mirrors/star9/star