0.1.0 • Published 3 years ago

xfj-node v0.1.0

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

xfj-node

1. 背景

在使用 nodejs 搭建后端服务时,一般需要创建一些结构型的项目目录,使代码的结构更清晰明了。

2. 需求

xfj-node 插件可以帮助开发者创建项目中的必要文件。其创建的项目目录结构如下:

  1. bin
    1. bin/www.js ------- 项目的入口文件
  2. src
    1. app.js
    2. router/ ------- 路由存放文件夹
    3. controller/ ------- 业务逻辑处理文件夹
    4. model/ ------- 数据库表模型文件夹
    5. db/ ------- 查询数据库数据的文件夹
    6. public/ ------- html 模板存放文件夹
    7. util/ ------- 工具文件夹
    8. conf/ ------- 配置文件夹
  3. test

    测试案例编写文件夹

  4. dist

    文件编译后存放的目录

  5. doc

    文档存放目录

3. 使用

  1. 新建一个文件夹 demo
  2. demo 文件夹下通过 npm init -y 生成 package.json
  3. demo 的根目录下运行 npm i xfj-node 安装插件
  4. 命令行执行 npx xfj-node 即可生成项目的结构目录