Nimiq Core JS 项目启动与配置教程

1. 项目目录结构及介绍

Nimiq Core JS 是 Nimiq 协议的官方 JavaScript 实现，其项目目录结构如下：

• clients: 客户端代码目录，包含浏览器和 Node.js 客户端。
• dist: 构建输出目录，包含编译后的 JavaScript 文件。
• doc: 项目文档目录。
• docker: Docker 相关文件。
• packaging: 打包相关文件，用于构建 Linux 的 .deb 和 RPM 包。
• spec/: 测试规范目录。
• support: 支持文件目录。
• .github: GitHub 工作流和模板文件。
• .dockerignore: Docker 忽略文件。
• .editorconfig: 编辑器配置文件。
• .esdoc.json: ESDoc 配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .npmignore: npm 忽略文件。
• LICENSE.md: 项目许可证文件。
• README.md: 项目自述文件。
• SECURITY.md: 安全策略文件。
• binding.gyp: Node.js 绑定配置文件。
• gulpfile.js: Gulp 任务配置文件。
• karma.conf.js: Karma 测试配置文件。
• package.json: npm 包配置文件。
• tslint.json: TSLint 配置文件。
• yarn.lock: Yarn 锁定文件。

每个目录和文件都有其特定的用途，为项目的开发、构建和测试提供支持。

2. 项目的启动文件介绍

项目的启动文件主要位于 clients 目录下：

• clients/browser/index.html: 浏览器客户端的入口 HTML 文件，可以用来在浏览器中查看和测试 Nimiq Core JS。
• clients/nodejs/nimiq: Node.js 客户端的启动脚本，用于在 Node.js 环境中启动 Nimiq 节点。

启动浏览器客户端，你只需打开 clients/browser/index.html 文件即可。

启动 Node.js 客户端，你需要满足以下条件：

• 拥有一个公网 IP 地址、域名和 SSL 证书（可以在 letsencrypt.org 获取免费证书）。
• 使用相应的配置文件。
• 在终端中运行 clients/nodejs/nimiq 脚本。

3. 项目的配置文件介绍

项目的配置文件主要涉及以下几个文件：

• package.json: npm 包的配置文件，其中包含了项目的依赖、脚本和元数据。
• .eslintrc.json: ESLint 配置文件，用于定义 JavaScript 代码风格和规则。
• tslint.json: TSLint 配置文件，用于 TypeScript 代码的静态检查。

在项目开发过程中，你可能需要根据自己的需求修改这些配置文件。例如，在 package.json 中添加或修改脚本，或在 ESLint 配置中添加自定义规则。

要构建项目，你可以执行以下命令：

cd core-js && yarn && yarn build

此命令会安装项目依赖并执行构建过程，生成可在浏览器或 Node.js 中使用的 JavaScript 文件。