创建项目 - 985ch/egg-sachikawa GitHub Wiki

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

我们推荐使用egg的脚手架来快速创建项目。尽管开发者也可以选择手动创建整个项目，但是并不推荐，因此这里不做介绍。
下文描述了用脚手架创建一个名叫myserver的项目的详细步骤：

1. 创建目录，利用脚手架初始化目录之后安装依赖包

$ mkdir myserver && cd myserver
$ npm init egg --type=simple
$ npm i egg-sachikawa --save
$ npm i

2. 编辑package.json文件，在egg项目下加入"framework":"egg-sachikawa"来启用sachikawa框架
3. 修改app/router.js文件，改用路由工厂来创建路由

// app/router.js
'use strict';
module.exports = app => {
  app.routerFactory.buildAllRouters(app.router);
};

4. 移除app/controller目录下的home.js文件，因为我们暂时用不到这个文件

$ cd app && rm controller/home.js

5. 在app目录下创建http目录及其两个子目录get和post

$ mkdir http && cd http
$ mkdir get && mkdir post

6. 在app/http/get目录下添加你的第一个接口test.js

//app/http/get/test.js
'use strict';

module.exports = () => {
  return {
    async controller() {
      this.success('hello, egg-sachikawa');
    },
  };
};

7. 如果不连接数据库，暂时在config/plugin.js把数据库插件屏蔽掉

// config/plugin.js
'use strict';

module.exports = {
  sequelize: {
    enable: false,
  },
};

8. 项目创建完成，可以通过以下命令启动项目进行测试了

$ npm run dev