austin-admin 项目安装与使用教程

1. 项目目录结构及介绍

austin-admin/
├── doc/
├── pages/
├── public/
├── sdk/
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── index.html
├── nodemon.json
├── package.json
└── server.js

• doc/: 存放项目文档的目录。
• pages/: 存放项目页面的目录。
• public/: 存放公共资源的目录。
• sdk/: 存放项目使用的SDK文件的目录。
• .gitignore: Git忽略文件配置。
• .prettierrc: Prettier代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• index.html: 项目主页HTML文件。
• nodemon.json: Nodemon配置文件。
• package.json: 项目依赖和脚本配置文件。
• server.js: 项目启动文件。

2. 项目启动文件介绍

server.js

server.js 是项目的启动文件，负责启动服务器并加载项目的前端资源。以下是文件的基本结构和功能介绍：

const express = require('express');
const bodyParser = require('body-parser');
const morgan = require('morgan');
const reload = require('reload');

const app = express();

// 中间件配置
app.use(bodyParser.json());
app.use(morgan('dev'));

// 静态资源路径
app.use(express.static('public'));

// 路由配置
app.get('/', (req, res) => {
  res.sendFile(__dirname + '/index.html');
});

// 启动服务器
const server = app.listen(3001, () => {
  console.log('Server is running on http://localhost:3001');
});

// 热更新配置
reload(app, server);

• express: 使用Express框架搭建服务器。
• bodyParser: 解析请求体中的JSON数据。
• morgan: 日志中间件，用于记录请求日志。
• reload: 热更新模块，用于在开发过程中自动刷新页面。
• express.static: 配置静态资源路径。
• app.get('/', ...): 配置根路径的路由，返回index.html文件。
• server.listen: 启动服务器，监听3001端口。

3. 项目的配置文件介绍

package.json

package.json 是Node.js项目的配置文件，包含了项目的依赖、脚本命令等信息。以下是文件的基本结构和功能介绍：

{
  "name": "amis-boilerplate",
  "version": "1.0.0",
  "description": "基于 amis 的项目模板",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "node server.js",
    "gh-pages": "rm -rf gh-pages && fis3 release gh-pages -c",
    "deploy-gh-pages": "git subtree push --prefix gh-pages origin gh-pages"
  },
  "keywords": [
    "amis",
    "boilerplate",
    "admin",
    "react"
  ],
  "author": "fex",
  "license": "MIT",
  "devDependencies": {
    "body-parser": "^1.19.0",
    "express": "^4.17.1",
    "morgan": "^1.10.0",
    "nodemon": "^2.0.7",
    "reload": "^3.1.1"
  }
}

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目入口文件。
• scripts: 定义项目的脚本命令，如start、test等。
• keywords: 项目关键词，便于在npm上搜索。
• author: 项目作者。
• license: 项目许可证。
• devDependencies: 开发依赖包，如express、body-parser等。

nodemon.json

nodemon.json 是Nodemon的配置文件，用于在开发过程中自动重启服务器。以下是文件的基本结构和功能介绍：

{
  "watch": ["server.js", "public/**/*"],
  "ext": "js,html,css",
  "ignore": ["node_modules"],
  "exec": "node server.js"
}

• watch: 监听的文件或目录，当这些文件发生变化时，Nodemon会自动重启服务器。
• ext: 监听的文件扩展名。
• ignore: 忽略的文件或目录。
• exec: 执行的命令，这里是启动server.js。

通过以上配置，开发者可以在修改代码后，自动重启服务器，提高开发效率。