feat: add sequelize example (#32)

Author: iyuq

.travis.yml

@@ -4,6 +4,8 @@ node_js:
  - '6'
  - '7'
  - '8'
+services:
+ - postgresql
 install:
  - npm i npminstall && npminstall
 script:

README.md

@@ -24,5 +24,6 @@ $ npm start
 - [unittest](https://github.com/eggjs/examples/tree/master/unittest)
 - [view-nunjucks](https://github.com/eggjs/examples/tree/master/view-nunjucks)
 - [custom-env](https://github.com/eggjs/examples/tree/master/custom-env)
+- [sequelize-example](https://github.com/eggjs/examples/tree/master/sequelize-example)
 
 [egg]: https://github.com/eggjs/egg

sequelize-example/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: node_js
+node_js:
+ - '6'
+ - '7'
+ - '8'
+services:
+ - postgresql
+install:
+ - npm i npminstall && npminstall
+script:
+ - npm run ci
+after_script:
+ - npminstall codecov && codecov

sequelize-example/README.md

@@ -0,0 +1,38 @@
+# sequelize-example
+
+The [egg] example project that uses [egg-sequelize] plugin.
+
+## QuickStart
+
+<!-- add docs here for user -->
+
+see [egg docs][egg] for more detail.
+
+### Development
+```bash
+$ npm install
+$ createdb example-dev --owner postgres
+$ npm run migrate:up
+$ npm run dev
+$ open http://localhost:7001/users
+```
+
+### Deploy
+
+Use `EGG_SERVER_ENV=prod` to enable prod mode
+
+```bash
+$ createdb example-prod --owner postgres
+$ NODE_ENV=production npm run migrate:up
+$ EGG_SERVER_ENV=prod npm start
+```
+
+### npm scripts
+
+- Use `npm run lint` to check code style.
+- Use `npm test` to run unit test.
+- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.
+
+
+[egg]: https://eggjs.org
+[egg-sequelize]: https://github.com/eggjs/egg-sequelize

sequelize-example/README.zh-CN.md

@@ -0,0 +1,43 @@
+# sequelize-example
+
+使用 [egg-sequelize] 插件的 [egg] 示例项目。
+
+## 快速入门
+
+<!-- 在此次添加使用文档 -->
+
+如需进一步了解，参见 [egg 文档][egg]。
+
+### 本地开发
+```bash
+$ npm install
+$ createdb example-dev --owner postgres
+$ npm run migrate:up
+$ npm run dev
+$ open http://localhost:7001/users
+```
+
+### 部署
+
+线上正式环境用 `EGG_SERVER_ENV=prod` 来启动。
+
+```bash
+$ createdb example-prod --owner postgres
+$ NODE_ENV=production npm run migrate:up
+$ EGG_SERVER_ENV=prod npm start
+```
+
+### 单元测试
+- [egg-bin] 内置了 [mocha], [thunk-mocha], [power-assert], [istanbul] 等框架，让你可以专注于写单元测试，无需理会配套工具。
+- 断言库非常推荐使用 [power-assert]。
+- 具体参见 [egg 文档 -单元测试](https://eggjs.org/zh-cn/core/unittest)。
+
+### 内置指令
+
+- 使用 `npm run lint` 来做代码风格检查。
+- 使用 `npm test` 来执行单元测试。
+- 使用 `npm run autod` 来自动检测依赖更新，详细参见 [autod](https://www.npmjs.com/package/autod) 。
+
+
+[egg]: https://eggjs.org
+[egg-sequelize]: https://github.com/eggjs/egg-sequelize

sequelize-example/app/controller/post.js

@@ -0,0 +1,39 @@
+'use strict';
+
+module.exports = app => {
+ return class UserController extends app.Controller {
+ * posts() {
+ const ctx = this.ctx;
+ ctx.body = yield ctx.service.post.list(ctx.query);
+ }
+
+ * post() {
+ const ctx = this.ctx;
+ ctx.body = yield ctx.service.post.find(ctx.params.id);
+ }
+
+ * create() {
+ const ctx = this.ctx;
+ const body = ctx.request.body;
+ body.user_id = +ctx.params.user_id;
+ const created = yield ctx.service.post.create(ctx.request.body);
+ ctx.status = 201;
+ ctx.body = created;
+ }
+
+ * update() {
+ const ctx = this.ctx;
+ const id = ctx.params.id;
+ const user_id = +ctx.params.user_id;
+ const body = ctx.request.body;
+ ctx.body = yield ctx.service.post.update({ id, user_id, updates: body });
+ }
+
+ * del() {
+ const ctx = this.ctx;
+ const id = ctx.params.id;
+ yield ctx.service.post.del(id);
+ ctx.status = 200;
+ }
+ };
+};

sequelize-example/app/controller/user.js

@@ -0,0 +1,36 @@
+'use strict';
+
+module.exports = app => {
+ return class UserController extends app.Controller {
+ * users() {
+ const ctx = this.ctx;
+ ctx.body = yield ctx.service.user.list(ctx.query);
+ }
+
+ * user() {
+ const ctx = this.ctx;
+ ctx.body = yield ctx.service.user.find(ctx.params.id);
+ }
+
+ * create() {
+ const ctx = this.ctx;
+ const created = yield ctx.service.user.create(ctx.request.body);
+ ctx.status = 201;
+ ctx.body = created;
+ }
+
+ * update() {
+ const ctx = this.ctx;
+ const id = ctx.params.id;
+ const body = ctx.request.body;
+ ctx.body = yield ctx.service.user.update({ id, updates: body });
+ }
+
+ * del() {
+ const ctx = this.ctx;
+ const id = ctx.params.id;
+ yield ctx.service.user.del(id);
+ ctx.status = 200;
+ }
+ };
+};

sequelize-example/app/model/post.js

@@ -0,0 +1,24 @@
+'use strict';
+
+module.exports = app => {
+ const { STRING, INTEGER, DATE } = app.Sequelize;
+
+ return app.model.define('post', {
+ id: {
+ type: INTEGER,
+ primaryKey: true,
+ autoIncrement: true,
+ },
+ title: STRING(30),
+ content: STRING(255),
+ user_id: INTEGER,
+ created_at: DATE,
+ updated_at: DATE,
+ }, {
+ classMethods: {
+ associate() {
+ app.model.Post.belongsTo(app.model.User, { as: 'user', foreignKey: 'user_id' });
+ },
+ },
+ });
+};

sequelize-example/app/model/user.js

@@ -0,0 +1,23 @@
+'use strict';
+
+module.exports = app => {
+ const { STRING, INTEGER, DATE } = app.Sequelize;
+
+ return app.model.define('user', {
+ id: {
+ type: INTEGER,
+ primaryKey: true,
+ autoIncrement: true,
+ },
+ name: STRING(30),
+ age: INTEGER,
+ created_at: DATE,
+ updated_at: DATE,
+ }, {
+ classMethods: {
+ associate() {
+ app.model.User.hasMany(app.model.Post, { as: 'posts', foreignKey: 'user_id' });
+ },
+ },
+ });
+};

sequelize-example/app/router.js

@@ -0,0 +1,15 @@
+'use strict';
+
+module.exports = app => {
+ app.get('/users', 'user.users');
+ app.get('/users/:id', 'user.user');
+ app.post('/users', 'user.create');
+ app.put('/users/:id', 'user.update');
+ app.del('/users/:id', 'user.del');
+
+ app.get('/posts', 'post.posts');
+ app.get('/posts/:id', 'post.post');
+ app.post('/users/:user_id/posts', 'post.create');
+ app.put('/users/:user_id/posts/:id', 'post.update');
+ app.del('/users/:user_id/posts/:id', 'post.del');
+};