Genie Server 项目安装与使用教程

1. 项目目录结构及介绍

Genie Server 项目的目录结构如下：

genie-server/
├── bin/
├── config/
├── dist/
├── docs/
├── lib/
├── node_modules/
├── public/
├── scripts/
├── src/
├── test/
├── .gitignore
├── .npmignore
├── .prettierrc
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── webpack.config.js

目录介绍：

• bin/: 包含项目的可执行文件。
• config/: 包含项目的配置文件。
• dist/: 包含编译后的文件。
• docs/: 包含项目的文档。
• lib/: 包含项目的库文件。
• node_modules/: 包含项目的依赖模块。
• public/: 包含公开的静态文件。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码。
• test/: 包含项目的测试文件。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• .prettierrc: Prettier 配置文件。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目启动文件介绍

项目的启动文件位于 src/ 目录下，通常是 index.ts 或 main.ts。启动文件的主要作用是初始化服务器并启动应用程序。

示例启动文件 (src/index.ts):

import express from 'express';
import { config } from './config';

const app = express();

app.listen(config.port, () => {
  console.log(`Server is running on port ${config.port}`);
});

启动命令：

在项目根目录下运行以下命令启动服务器：

npm start

3. 项目的配置文件介绍

项目的配置文件通常位于 config/ 目录下，常见的配置文件包括 config.json 或 config.ts。配置文件用于定义项目的各种参数和设置。

示例配置文件 (config/config.ts):

export const config = {
  port: process.env.PORT || 3000,
  database: {
    host: process.env.DB_HOST || 'localhost',
    port: process.env.DB_PORT || 5432,
    name: process.env.DB_NAME || 'genie',
  },
  logging: {
    level: process.env.LOG_LEVEL || 'info',
  },
};

配置文件的使用：

在启动文件中导入并使用配置文件：

import { config } from './config';

app.listen(config.port, () => {
  console.log(`Server is running on port ${config.port}`);
});

通过以上步骤，您可以成功安装并启动 Genie Server 项目，并了解其目录结构、启动文件和配置文件的基本信息。