1. 安装nodejs环境,官方要求8.X以上,npm6.1以上。
2. 创建文件夹,在文件夹内打开cmd窗口,初始化项目 ,如下图:
npm init egg --type=simple
如果未安装create-egg会有安装提示,如图:输入 y,等待,界面会弹出让选择你要创建的那种结构的应用,我们选则simple,其他具体区别请参照官网说明。教程 - Egg (eggjs.org)
如果创建应用超时,需要设置npm镜像,可以利用以下脚本设置:
npm config set registry https://registry.npmmirror.com
选择完应用结构以后,会提示输入相关信息,包括工程名,描述,作者,cookie的安全密钥等,输入完成后回车,即可完成创建。
打开文件夹,在文件夹内执行 npm install ,完成后执行npm run dev即可启动项目。
此时目录中结构可参考如下截图:
如上,由框架约定的目录:
app/router.js
用于配置 URL 路由规则,具体参见 Router。app/controller/**
用于解析用户的输入,处理后返回相应的结果,具体参见 Controller。app/service/**
用于编写业务逻辑层,建议使用,具体参见 Service。app/middleware/**
用于编写中间件,具体参见 Middleware。app/public/**
用于放置静态资源,具体参见内置插件 egg-static。app/extend/**
用于框架的扩展,具体参见 框架扩展。config/config.{env}.js
用于编写配置文件,具体参见 配置。config/plugin.js
用于配置需要加载的插件,具体参见 插件。test/**
用于单元测试,具体参见 单元测试。app.js
和agent.js
用于自定义启动时的初始化工作,具体参见 启动自定义。关于agent.js
的作用,参见 Agent 机制。
由内置插件约定的目录:
app/public/**
用于放置静态资源,具体参见内置插件 egg-static。app/schedule/**
用于定时任务,具体参见 定时任务。
若需自定义自己的目录规范,参见 Loader API
app/view/**
用于放置模板文件,具体参见 模板渲染。app/model/**
用于放置领域模型,如 egg-sequelize 等领域类相关插件。
本节完成,下一节开始讲连接数据库。