title: Quick Start

This guide covers getting up and running a real example using Egg.
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: 8.x or newer; it is recommended that you use LTS Releases.

the Quick Way

To begin with, let’s quickly initialize the project by using a scaffold,
which will quickly generate some of the major pieces of the application.

  1. $ npm i egg-init -g
  2. $ egg-init egg-example --type=simple
  3. $ cd egg-example
  4. $ npm i

Then get up and run by using the following commands.

  1. $ npm run dev
  2. $ open localhost:7001

Step by Step

Usually you can just use egg-init of the previous section,
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.

Egg HackerNews Snapshoot

Initialization

First let’s create the project directory and initialize its structure.

  1. $ mkdir egg-example
  2. $ cd egg-example
  3. $ npm init
  4. $ npm i egg --save
  5. $ npm i egg-bin --save-dev

Then add npm scripts to package.json.

  1. {
  2.   "name": "egg-example",
  3.   "scripts": {
  4.     "dev": "egg-bin dev"
  5.   }
  6. }

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.

  1. // app/controller/home.js
  2. const Controller = require('egg').Controller;
  4. class HomeController extends Controller {
  5.   async index() {
  6.     this.ctx.body = 'Hello world';
  7.   }
  8. }
  10. module.exports = HomeController;

Then edit the router file and add a mapping.

  1. // app/router.js
  2. module.exports = app => {
  3.   const { router, controller } = app;
  4.   router.get('/', controller.home.index);
  5. };

Then add a configuration file:

  1. // config/config.default.js
  2. exports.keys = <YOUR_SECURITY_COOKE_KEYS>;

The project directory looks like this:

  1. egg-example
  2. ├── app
  3. │   ├── controller
  4. │   │   └── home.js
  5. │   └── router.js
  6. ├── config
  7. │   └── config.default.js
  8. └── package.json

For more information about directory structure, see Directory Structure.

Now you can start up the Web Server and see your application in action.

  1. $ npm run dev
  2. $ open localhost:7001

Note：

  • You could write Controller with class or exports style, see more detail at Controller.
  • And Config could write with module.exports or exports style, 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.

  1. app/public
  2. ├── css
  3. │   └── news.css
  4. └── js
  5.     ├── lib.js
  6.     └── 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 to use any particular template engines,
but specifies the View Plug-ins Specification
to allow the developers to use different plug-ins for their individual needs instead.

For more information, cf. View.

In this example, we will use Nunjucks.

First install the corresponding plug-in egg-view-nunjucks.

  1. $ npm i egg-view-nunjucks --save

And enable it.

  1. // config/plugin.js
  2. exports.nunjucks = {
  3.   enable: true,
  4.   package: 'egg-view-nunjucks'
  5. };
  1. // config/config.default.js
  2. exports.keys = <YOUR_SECURITY_COOKE_KEYS>;
  3. // add view's configurations
  4. exports.view = {
  5.   defaultViewEngine: 'nunjucks',
  6.   mapping: {
  7.     '.tpl': 'nunjucks',
  8.   },
  9. };

Carefully! config dir, not app/config!

Then create a template for the index page.
This usually goes to the app/view directory.

  1. <!-- app/view/news/list.tpl -->
  2. <html>
  3.   <head>
  4.     <title>Egg HackerNews Clone</title>
  5.     <link rel="stylesheet" href="/public/css/news.css" />
  6.   </head>
  7.   <body>
  8.     <ul class="news-view view">
  9.       {% for item in list %}
  10.         <li class="item">
  11.           <a href="{{ item.url }}">{{ item.title }}</a>
  12.         </li>
  13.       {% endfor %}
  14.     </ul>
  15.   </body>
  16. </html>

Then add a controller and router.

  1. // app/controller/news.js
  2. const Controller = require('egg').Controller;
  4. class NewsController extends Controller {
  5.   async list() {
  6.     const dataList = {
  7.       list: [
  8.         { id: 1, title: 'this is news 1', url: '/news/1' },
  9.         { id: 2, title: 'this is news 2', url: '/news/2' }
  10.       ]
  11.     };
  12.     await this.ctx.render('news/list.tpl', dataList);
  13.   }
  14. }
  16. module.exports = NewsController;
  18. // app/router.js
  19. module.exports = app => {
  20.   const { router, controller } = app;
  21.   router.get('/', controller.home.index);
  22.   router.get('/news', controller.news.list);
  23. };

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 be abstracted as
a busineess logic layer instead, i.e., service.

Let’s create a service to fetch data from the
HackerNews.

  1. // app/service/news.js
  2. const Service = require('egg').Service;
  4. class NewsService extends Service {
  5.   async list(page = 1) {
  6.     // read config
  7.     const { serverUrl, pageSize } = this.config.news;
  9.     // use build-in http client to GET hacker-news api
  10.     const { data: idList } = await this.ctx.curl(`${serverUrl}/topstories.json`, {
  11.       data: {
  12.         orderBy: '"$key"',
  13.         startAt: `"${pageSize * (page - 1)}"`,
  14.         endAt: `"${pageSize * page - 1}"`,
  15.       },
  16.       dataType: 'json',
  17.     });
  19.     // parallel GET detail
  20.     const newsList = await Promise.all(
  21.       Object.keys(idList).map(key => {
  22.         const url = `${serverUrl}/item/${idList[key]}.json`;
  23.         return this.ctx.curl(url, { dataType: 'json' });
  24.       })
  25.     );
  26.     return newsList.map(res => res.data);
  27.   }
  28. }
  30. module.exports = NewsService;

Egg has HttpClient built in in order to help you make HTTP requests.

Then slightly modify our previous controller.

  1. // app/controller/news.js
  2. const Controller = require('egg').Controller;
  4. class NewsController extends Controller {
  5.   async list() {
  6.     const ctx = this.ctx;
  7.     const page = ctx.query.page || 1;
  8.     const newsList = await ctx.service.news.list(page);
  9.     await ctx.render('news/list.tpl', { list: newsList });
  10.   }
  11. }
  13. module.exports = NewsController;

And also add config.

  1. // config/config.default.js
  2. // add news' configurations
  3. exports.news = {
  4.   pageSize: 5,
  5.   serverUrl: 'https://hacker-news.firebaseio.com/v0',
  6. };

Add Extensions

We might encounter a small problem here.
The time that we fetched are Unix Time format,
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.

  1. $ npm i moment --save
  1. // app/extend/helper.js
  2. const moment = require('moment');
  3. exports.relativeTime = time => moment(new Date(time * 1000)).fromNow();

Then use it in the templates.

  1. <!-- app/view/news/list.tpl -->
  2. {{ 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.

  1. // app/middleware/robot.js
  2. // options === app.config.robot
  3. module.exports = (options, app) => {
  4.   return async function robotMiddleware(ctx, next) {
  5.     const source = ctx.get('user-agent') || '';
  6.     const match = options.ua.some(ua => ua.test(source));
  7.     if (match) {
  8.       ctx.status = 403;
  9.       ctx.message = 'Go away, robot.';
  10.     } else {
  11.       await next();
  12.     }
  13.   }
  14. };
  16. // config/config.default.js
  17. // add middleware robot
  18. exports.middleware = [
  19.   'robot'
  20. ];
  21. // robot's configurations
  22. exports.robot = {
  23.   ua: [
  24.     /Baiduspider/i,
  25.   ]
  26. };

Now try it using curl localhost:7001/news -A "Baiduspider".

See Middleware for more details.

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 be set wherever convenient, e.g. near Applications/Plug-ins/Framesworks, and Egg will be careful to merge and load them.
  • For more information on merging, see Configurations.
  1. // config/config.default.js
  2. exports.robot = {
  3.   ua: [
  4.     /curl/i,
  5.     /Baiduspider/i,
  6.   ],
  7. };
  9. // config/config.local.js
  10. // only read at development mode, will override default
  11. exports.robot = {
  12.   ua: [
  13.     /Baiduspider/i,
  14.   ],
  15. };
  17. // app/service/some.js
  18. const Service = require('egg').Service;
  20. class SomeService extends Service {
  21.   async list() {
  22.     const rule = this.config.robot.ua;
  23.   }
  24. }
  26. module.exports = SomeService;

Add Unit Testing

Unit Testing is very important, and Egg also provides egg-bin to help you write tests painless.

All the test files should be placed at {app_root}/test/**/*.test.js.

  1. // test/app/middleware/robot.test.js
  2. const { app, mock, assert } = require('egg-mock/bootstrap');
  4. describe('test/app/middleware/robot.test.js', () => {
  5.   it('should block robot', () => {
  6.     return app.httpRequest()
  7.       .get('/')
  8.       .set('User-Agent', "Baiduspider")
  9.       .expect(403);
  10.   });
  11. });

Then add npm scripts.

  1. {
  2.   "scripts": {
  3.     "test": "egg-bin test",
  4.     "cov": "egg-bin cov"
  5.   }
  6. }

Also install dependencies.

  1. $ npm i egg-mock --save-dev

Run it.

  1. $ 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? read our documentation to better understand the framework.

  • About Egg boilerplate type, See Boilerplate Type Description.
  • Egg provides a powerful mechanism for extending features. See Plugin.
  • 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 suit 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.