Markdrop 项目启动与配置教程

1. 项目目录结构及介绍

Markdrop 项目的目录结构如下所示：

markdrop/
├── .gitignore             # Git 忽略文件列表
├── .vscode/               # VSCode 项目设置
│   └── settings.json      # VSCode 配置文件
├── assets/                # 静态资源目录
│   └── images/             # 图片资源
├── bin/                   # 执行文件目录
│   └── www.js              # 启动服务器脚本
├── docs/                  # 文档目录
│   └── ...                # 文档文件
├── node_modules/          # 项目依赖模块
├── package.json           # 项目配置文件
├── public/                # 公共目录
│   ├── css/               # CSS 样式文件
│   ├── js/                # JavaScript 文件
│   └── index.html         # 项目入口 HTML 文件
├── src/                   # 源代码目录
│   ├── components/        # 组件目录
│   ├── index.js           # 项目入口 JavaScript 文件
│   └── ...                # 其他源代码文件
└── test/                  # 测试目录
    └── ...                # 测试文件

• .gitignore：指定 Git 忽略跟踪的文件和目录。
• .vscode/：Visual Studio Code 编辑器配置。
• assets/：存储项目的静态资源，如图像等。
• bin/：存放可执行脚本，例如启动服务器的 www.js 文件。
• docs/：项目文档。
• node_modules/：存放项目依赖的第三方模块。
• package.json：定义项目依赖、脚本和元数据。
• public/：公共资源目录，通常包含 HTML、CSS 和 JavaScript 文件。
• src/：项目源代码目录。
• test/：项目测试相关文件。

2. 项目的启动文件介绍

项目的启动文件是位于 bin/ 目录下的 www.js。以下是 www.js 的基本内容：

const http = require('http');
const app = require('../src/app');

const port = process.env.PORT || 3000;

http.createServer(app).listen(port, () => {
  console.log(`Server running at http://localhost:${port}/`);
});

该文件使用 Node.js 的 http 模块创建一个 HTTP 服务器，并将 src/app 文件导出的应用实例作为服务器处理请求的回调函数。服务器默认监听 3000 端口，可以通过环境变量 PORT 来指定其他端口。

3. 项目的配置文件介绍

项目的配置文件是 package.json。以下是一些重要的配置项：

{
  "name": "markdrop",
  "version": "1.0.0",
  "description": "A Markdown presentation tool",
  "main": "index.js",
  "scripts": {
    "start": "node bin/www",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "express": "^4.17.1",
    "marked": "^1.2.7",
    " ... "
  },
  "author": "Shorya Sethia",
  "license": "ISC"
}

• name：项目名称。
• version：项目版本号。
• description：项目描述。
• main：项目的主入口文件。
• scripts：定义项目的脚本命令，start 脚本用于启动服务器。
• dependencies：项目依赖的第三方模块列表。
• author：项目作者。
• license：项目许可证。

使用 npm start 命令可以启动项目，该命令会执行 package.json 中定义的 start 脚本。