fau

fastify-angular-universal

Angular Universal integration to Fastify for rendering Angular apps on the server

Showing:

Popularity

Downloads/wk

6

GitHub Stars

21

Maintenance

Last Commit

3yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

95.5KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

fastify-angular-universal

Master - Build Status Master - Build Status LICENSE

Angular server-side rendering support for Fastify using Angular Universal.

Install

npm install --save fastify-angular-universal

Usage

Add it to you project with register and pass the required options.

Follow the tutorial on how to perform SSR in Angular with Angular CLI here ONLY UNTIL step 3.

For the steps 4 and onwards use the following server.ts or check out the server.ts in the test-app directory

// These are important and needed before anything else
import 'zone.js/dist/zone-node';
import 'reflect-metadata';

import { join } from 'path';
import { readFileSync } from 'fs';

import { enableProdMode } from '@angular/core';
import * as fastify from 'fastify';

// * NOTE :: leave this as require() since this file is built Dynamically from webpack
const { AppServerModuleNgFactory, LAZY_MODULE_MAP } = require('./dist/<your-project-name-here>-server/main');
const { provideModuleMap } = require('@nguniversal/module-map-ngfactory-loader');

// Faster server renders w/ Prod mode (dev mode never needed)
enableProdMode();

const PORT = process.env.PORT || 3000;
const DIST_FOLDER = join(process.cwd(), 'dist');

// Our index.html we'll use as our template
const template = readFileSync(join(DIST_FOLDER, '<your-project-name-here>', 'index.html')).toString();

const app = fastify();

app.register(require('fastify-static'), {
  root: join(DIST_FOLDER, '<your-project-name-here>'),
  prefix: '/static/'
});

// register the fastify-angular-universal to your application together with the required options
app.register(require('fastify-angular-universal'), {
  serverModule: AppServerModuleNgFactory,
  document: template,
  extraProviders: [
    provideModuleMap(LAZY_MODULE_MAP)
  ]
});

// Declare a route
app.get('/*', function (request, reply) {
  // NOTE: you can also pass the options for the fastify-angular-universal fastify plugin 
  //       as second parameter to the `.renderNg()` function.
  // 
  //       Example: `reply.renderNg(url, options)`
  (reply as any).renderNg(request.req.url);
});

// Run the server!
app.listen(PORT, function (err) {
  if (err) {
    throw err;
  }

  console.log(`server listening on ${app.server.address().port}`);
});

Options

This plugin allow you to specify options:

  • serverModule to specify the NgModuleFactory to be used in rendering an Angular app in the server
  • document to specify the template where the Angular app will be rendered
  • extraProviders to specify additional providers to be used by the Angular app. (optional)

License

MIT.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100