@ngx-universal/express-engine

Express engine for Angular Universal

Please support this project by simply putting a Github star. Share this library with friends on Twitter and everywhere else you can.

NOTICE

This 4.x.x branch is intented to work with @angular v4.x.x. If you're developing on a later release of Angular than v4.x.x, then you should probably choose the appropriate version of this library by visiting the master branch.

Table of contents:

• Prerequisites
• Getting started
  • Installation
    • Examples
    • Related packages
    • Adding @ngx-universal/express-engine to your project (SystemJS)
  • server configuration
• License

Prerequisites

This library depends on Angular v4.0.0. Older versions contain outdated dependencies, might produce errors.

Also, please ensure that you are using Typescript v2.3.4 or higher.

Getting started

Installation

You can install @ngx-universal/express-engine using npm

npm install @ngx-universal/express-engine --save

Examples

• ng-seed/universal is an officially maintained seed project, showcasing common patterns and best practices for @ngx-universal/express-engine.

Adding @ngx-universal/express-engine to your project (SystemJS)

Add map for @ngx-universal/express-engine in your systemjs.config

'@ngx-universal/express-engine': 'node_modules/@ngx-universal/express-engine/bundles/express-engine.umd.min.js'

server configuration

Import ngExpressEngine using the mapping '@ngx-universal/express-engine' on your server configuration (ex: server.ts) and bootstrap the AppServerModule (considering app.server.module is the server module in Angular Universal application) using ngExpressEngine as follows:

...
import * as express from 'express';
import { ngExpressEngine } from '@ngx-universal/express-engine';
import { AppServerModule } from './app.server.module';
...

const server = express();

server.engine('html', ngExpressEngine({
  bootstrap: AppServerModule
}));

server.set('view engine', 'html');
server.set('views', 'public');
...

:+1: Wow! @ngx-universal/express-engine will now bootstrap the AppServerModule on the server platform.

License

The MIT License (MIT)

Copyright (c) 2017 Burak Tasci