一、新建egg.js项目

新建egg.js项目

本文从实例的角度，一步步地搭建出一个egg.js应用。

环境

环境要求

• 操作系统：支持 macOS，Linux，Windows
• 运行环境：建议 nodejs 选择 LTS 版本，最低要求 8.x。

本例的实际环境：

• 操作系统：Windows 10 专业版
• 运行环境：nodejs 版本 v12.19.0。

使用egg.js脚手架快速搭建项目

• 使用 npm 安装

$ npm i egg-init -g  //安装脚手架
$ egg-init egg-example --type=simple  //生成项目egg-example
$ cd egg-example
$ npm i
$ npm run dev

• 使用 yarn 安装

$ yarn global add egg-init
$ egg-init egg-example --type=simple 
$ cd egg-example
$ yarn
$ yarn run dev

在浏览器中输入地址：localhost:7001

手动逐步搭建项目

• 初始化下目录结构

$ mkdir egg-example
$ cd egg-example
$ npm init
$ npm i egg --save
$ npm i egg-bin --save-dev

• 添加 npm scripts 到 package.json：

{
  "name": "egg-example",
  "scripts": {
    "dev": "egg-bin dev"
  }
}

• 创建的目录结构如下：
  egg-example
  ├── app
  │ ├── controller
  │ │ └── home.js
  │ └── router.js
  ├── config
  │ └── config.default.js
  └── package.json