Memex 项目启动与配置教程

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

Memex 项目是一个用于演示记忆扩展（Memex）概念的原型。项目的目录结构如下：

• app：包含 Electron 应用的主要代码。
• configs：配置文件存放目录。
• internals：内部工具和脚本。
• resources：静态资源文件，如图标、图片等。
• test：单元测试和集成测试代码。
• .github：GitHub 工作流和代码贡献准则。
• .vscode：Visual Studio Code 的配置文件。
• babel.config.js：Babel 配置文件，用于 JavaScript 代码转译。
• package.json：项目依赖和脚本。
• tsconfig.json：TypeScript 配置文件。
• yarn.lock：Yarn 锁文件，确保依赖的稳定性。
• CHANGELOG.md：项目更新日志。
• CODE_OF_CONDUCT.md：项目行为准则。
• LICENSE：项目许可证。
• README.md：项目说明文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 文件中的脚本。以下是启动文件的简要介绍：

• yarn dev：启动开发环境。这会启动一个 Webpack 开发服务器，并使渲染进程处于热模块替换模式。
• yarn package：为本地平台打包应用。

3. 项目的配置文件介绍

项目中的配置文件主要用于管理和定制项目的行为。以下是一些主要的配置文件介绍：

• babel.config.js：配置 Babel 转译规则，用于处理 JavaScript 代码。
• tsconfig.json：配置 TypeScript 编译选项。
• .gitignore：定义哪些文件和目录应该被 Git 忽略。
• .editorconfig：定义编辑器设置，以便不同开发者的编辑器保持一致性。
• .eslintrc.js：配置 ESLint 规则，用于代码风格检查。
• package.json 中的 scripts：定义了项目的运行脚本，如启动开发环境和打包应用。

在开始开发之前，请确保已经安装了 Node.js 和 Yarn。然后克隆仓库并安装依赖：

git clone https://github.com/steve-1820/memex.git
cd memex
yarn

启动开发环境：

yarn dev

确保你已经克隆并运行了配套的 Chrome 扩展（memex-chrome-extension），以便将用户行为（如阅读的博客和标记）发送到 Electron 应用。