12 KiB
title: Quick Start
Quick Start
This guide covers getting up and running with Egg using a real example. By following along with this guide step by step, you can quickly get started with Egg development.
Prerequisites
- Operating System: Linux, OS X or Windows.
- Node.js Runtime: 6.x or newer; it is recommended that you use LTS Releases.
the Quick Way
To begin with, let's quickly initialize the project using a scaffold, which will quickly generate some of the major pieces of the application.
$ npm i egg-init -g
$ egg-init egg-example --type=simple
$ cd egg-example
$ npm i
Then get up and running using the following commands.
$ npm run dev
$ open localhost:7001
Step by Step
Usually you could just use egg-init of the last session, choose a scaffold that best fits your business model and quickly generate a project, then get started with the development.
However, in this section, instead of using scaffolds we will build a project called Egg HackerNews step by step, for a better understanding of how it works.
Initialization
First let's create the project directory and initialize its structure.
$ mkdir egg-example
$ cd egg-example
$ npm init
$ npm i egg --save
$ npm i egg-bin --save-dev
Then add npm scripts to package.json.
{
"name": "egg-example",
"scripts": {
"dev": "egg-bin dev"
}
}
Create a Controller
If you are familiar with the MVC architecture, you might have already guessed that the first thing to create is a controller and router.
// app/controller/home.js
module.exports = app => {
class HomeController extends app.Controller {
* index() {
this.ctx.body = 'hi, egg';
}
}
return HomeController;
};
Then edit the router file and add a mapping.
// app/router.js
module.exports = app => {
app.get('/', app.controller.home.index);
};
Then add a configuration file:
// config/config.default.js
exports.keys = <YOUR_SECURITY_COOKE_KEYS>;
The project directory looks like this:
egg-example
├── app
│ ├── controller
│ │ └── home.js
│ └── router.js
├── config
│ └── config.default.js
└── package.json
For more infomation about directory structure, see Directory Structure.
Now you can start up the Web Server and see your application in action.
$ npm run dev
$ open localhost:7001
Note：
- You could write
Controllerwithclassorexportsstyle, see more detail at Controller.- And
Configcould write withmodule.exportsorexportsstyle, see more detail at Node.js modules docs.
Add Static Assets
Egg has a built-in plugin called static. In production, it is recommended that you deploy static assets to CDN instead of using this plugin.
static maps /public/* to the directory app/public/* by default.
In this case, we just need to put our static assets into the directory app/public.
app/public
├── css
│ └── news.css
└── js
├── lib.js
└── news.js
Add Templates for Rendering
In most cases, data are usually read, processed and rendered by the templates before being presented to the user. Thus we need to introduce corresponding template engines to handle it.
Egg does not force the use of any particular template engines, but instead specifies the View Plug-ins Specification to allow the developers to use different plug-ins for their individual needs.
For more information, cf. View.
In this example, we will use Nunjucks.
First install the corresponding plug-in egg-view-nunjucks.
$ npm i egg-view-nunjucks --save
And enable it.
// config/plugin.js
exports.nunjucks = {
enable: true,
package: 'egg-view-nunjucks'
};
// config/config.default.js
exports.keys = <YOUR_SECURITY_COOKE_KEYS>;
// add view's configurations
exports.view = {
defaultViewEngine: 'nunjucks',
mapping: {
'.tpl': 'nunjucks',
},
};
Carefull! config dir, not app/config!
Then create a template for the index page. This usually goes to the app/view directory.
<!-- app/view/news/list.tpl -->
<html>
<head>
<title>Egg HackerNews Clone</title>
<link rel="stylesheet" href="/public/css/news.css" />
</head>
<body>
<div class="news-view view">
{% for item in list %}
<div class="item">
<a href="{{ item.url }}">{{ item.title }}</a>
</div>
{% endfor %}
</div>
</body>
</html>
Then add a controller and router.
// app/controller/news.js
module.exports = app => {
class NewsController extends app.Controller {
* list() {
const dataList = {
list: [
{ id: 1, title: 'this is news 1', url: '/news/1' },
{ id: 2, title: 'this is news 2', url: '/news/2' }
]
};
yield this.ctx.render('news/list.tpl', dataList);
}
}
return NewsController;
};
// app/router.js
module.exports = app => {
app.get('/', app.controller.home.index);
app.get('/news', app.controller.news.list);
};
Open a browser window and navigate to http://localhost:7001/news. You should be able to see the rendered page.
Tip：In development, Egg enables the development plug-in by default, which reloads your worker process when changes are made to your back-end code.
Create a Service
In practice, controllers usually won't generate data on their own, neither will they contain complicated business logic. Complicated business logic should instead be abstracted as a busineess logic layer, i.e., service.
Let's create a service to fetch data from the HackerNews.
// app/service/news.js
module.exports = app => {
class NewsService extends app.Service {
* list(page = 1) {
// read config
const { serverUrl, pageSize } = this.app.config.news;
// use built-in HttpClient to GET hacker-news api
const { data: idList } = yield this.ctx.curl(`${serverUrl}/topstories.json`, {
data: {
orderBy: '"$key"',
startAt: `"${pageSize * (page - 1)}"`,
endAt: `"${pageSize * page - 1}"`,
},
dataType: 'json',
});
// parallel GET detail , see `yield {}` from co
const newsList = yield Object.keys(idList).map(key => {
const url = `${serverUrl}/item/${idList[key]}.json`;
return this.ctx.curl(url, { dataType: 'json' });
});
return newsList.map(res => res.data);
}
}
return NewsService;
};
Egg has HttpClient built in in order to help you make HTTP requests.
Then slightly modify our previous controller.
// app/controller/news.js
module.exports = app => {
class NewsController extends app.Controller {
* list() {
const ctx = this.ctx;
const page = ctx.query.page || 1;
const newsList = yield ctx.service.news.list(page);
yield ctx.render('news/list.tpl', { list: newsList });
}
}
return NewsController;
};
And also add config.
// config/config.default.js
// add news' configurations
exports.news = {
pageSize: 5,
serverUrl: 'https://hacker-news.firebaseio.com/v0',
};
Note: async function is also built-in supported, see async-function.
Add Extensions
We might encounter a small problem here. The time that we fetched are in Unix Time, whereas we want to present them in a more friendly way to read.
Egg provides us with a quick way to extend its functionalities.
We just need to add extension scripts to the app/extend directory.
For more information, cf. Extensions.
In the case of view, we can just write a helper as an extension.
// app/extend/helper.js
const moment = require('moment');
exports.relativeTime = time => moment(new Date(time * 1000)).fromNow();
Then use it in the templates.
<!-- app/views/news/list.tpl -->
{{ helper.relativeTime(item.time) }}
Add Middlewares
Suppose that we wanted to prohibit accesses from Baidu crawlers.
Smart developers might quickly guess that we can achieve it by adding a middleware that checks the User-Agent.
// app/middleware/robot.js
// options === app.config.robot
module.exports = (options, app) => {
return function* robotMiddleware(next) {
const source = this.get('user-agent') || '';
const match = options.ua.some(ua => ua.test(source));
if (match) {
this.status = 403;
this.message = 'go away, robot';
} else {
yield next;
}
}
};
// config/config.default.js
// add middleware robot
exports.middleware = [
'robot'
];
// robot's configurations
exports.robot = {
ua: [
/Baiduspider/i,
]
};
Now try it using curl localhost:7001/news -A "Baiduspider".
Note：both Koa1 and Koa2 style middleware is supported, see Use Koa's Middleware。
Add Configurations
When writing business logic, it is inevitable that we need to manage configurations. Egg provides a powerful way to manage them in a merged configuration file.
- Environment-specific configuration files are well supported, e.g. config.local.js, config.prod.js, etc.
- Configurations could happen wherever convenient, e.g. near Applications/Plug-ins/Framesworks, and Egg will take care of merging and loading them.
- For more information on merging, see Configurations.
// config/config.default.js
exports.robot = {
ua: [
/curl/i,
/Baiduspider/i,
],
};
// config/config.local.js
// only read at development mode, will override default
exports.robot = {
ua: [
/Baiduspider/i,
],
};
// app/service/some.js
module.exports = app => {
class SomeService extends app.Service {
* list() {
const rule = this.app.config.robot.ua;
}
}
return SomeService;
};
Add Unit Testing
Unit Testing is very important, and Egg also provide [egg-bin] to help you write tests painless.
All the test files should place at {app_root}/test/**/*.test.js.
// test/app/middleware/robot.test.js
const assert = require('assert');
const mock = require('egg-mock');
describe('test/app/middleware/robot.test.js', () => {
let app;
before(() => {
app = mock.app();
return app.ready();
});
afterEach(mock.restore);
it('should block robot', () => {
return app.httpRequest()
.get('/')
.set('User-Agent', "Baiduspider")
.expect(403);
});
// ...
});
Then add npm scripts.
{
"scripts": {
"test": "egg-bin test"
}
}
Also install dependencies.
$ npm i egg-mock --save-dev
Run it.
$ npm test
That is all of it, for more detail, see Unit Testing.
Conclusions
We can only touch the tip of the iceberg of Egg with the above short sections. Where to go from here? Browse our documentation to better understand the framework.
- Egg provides a powerful mechanism for extending features. See Plug-ins.
- Egg framework allows small or large teams to work together as fast as possible under the well-documented conventions and coding best practices. In addition, the teams can build up logics on top of the framework to better suited their special needs. See more on [Frameworks].(../advanced/framework.md).
- Egg framework provides code reusabilities and modularities. See details at Progressive.
- Egg framework enables developers to write painless unit testing with many plugins and community-powered toolings. The team should give it a try by using Egg unit testing without worrying about setting up the testing tooling but writing the testing logics. See Unit Testing.