Universal javascript support for Angular
TypeScript Python Shell JavaScript HTML
Clone or download
Permalink
Failed to load latest commit information.
.circleci ci: increase resources for testing (#1020) Jun 10, 2018
.github ci: increase resources for testing (#1020) Jun 10, 2018
docs docs: refactor READMEs (#1006) Jun 4, 2018
integration feat(hapi): upgrade to Hapi v17 (#1015) Jun 10, 2018
modules feat(hapi): upgrade to Hapi v17 (#1015) Jun 10, 2018
scripts test(e2e): add e2e testing (#1013) Jun 10, 2018
tools feat(hapi): upgrade to Hapi v17 (#1015) Jun 10, 2018
.editorconfig chore(.editorconfig): remove newline for .json Aug 7, 2015
.gitignore test(e2e): add e2e testing (#1013) Jun 10, 2018
.npmignore feat(universal): AOT support (#560) Oct 5, 2016
BUILD.bazel build: upgrade bazel to latest (#1008) Jun 8, 2018
CHANGELOG.md chore(release): 6.0.0 May 3, 2018
CONTRIBUTING.md chore(example): clean up unmaintained examples folder Jul 12, 2016
LICENSE chore: bump year Feb 13, 2018
README.md docs: fix link to module-map-ngfactory-loader (#1026) Jun 15, 2018
UPGRADE-GUIDE.md docs: refactor READMEs (#1006) Jun 4, 2018
WORKSPACE build: upgrade bazel to latest (#1008) Jun 8, 2018
angular.tsconfig.json test(e2e): add e2e testing (#1013) Jun 10, 2018
package.json feat(hapi): upgrade to Hapi v17 (#1015) Jun 10, 2018
publish-next.sh build: add bazel publish scripts (#972) Apr 28, 2018
publish.sh build: add bazel publish scripts (#972) Apr 28, 2018
tsconfig.json test(express-engine): add basic unit tests (#953) Apr 14, 2018
tslint.json build: remove old build system (#971) Apr 28, 2018
yarn.lock feat(hapi): upgrade to Hapi v17 (#1015) Jun 10, 2018

README.md

Build Status Join the chat at https://gitter.im/angular/universal

Angular Universal

Angular Universal

Table of Contents


Introduction

The Angular Universal project is a community driven project to expand on the core APIs from Angular (platform-server) to enable developers to do server side rendering of Angular applications in a variety of scenarios.

This repository will host the various tools like engines to integrate with various backends(NodeJS, ASP.NET etc.) and also extra modules and examples to help you started with server side rendering.

The Universal project is driven by community contributions. Please send us your Pull Requests!

Getting Started

* NodeJS :: Example repo

  • Minimal universal example

* ASP.NET Core :: Universal Starter repo

  • Installation: Clone the above repo, npm i && dotnet restore (VStudio will run these automatically when opening the project)
  • Launch files included for both VSCode & VStudio to run/debug automatically (press F5).

Packages

The packages from this repo are published as scoped packages under @nguniversal

Universal "Gotchas"

Moved to /docs/gotchas.md

Roadmap

Completed

  • Integrate the platform API into core
  • Support Title and Meta services on the server
  • Develop Express, ASP.NET Core, Hapi engines
  • Angular CLI support for Universal
  • Provide a DOM implementation on the server
  • Hooks in renderModule* to do stuff just before rendering to string
  • Generic state transfer API in the platform
  • Http Transfer State Module that uses HTTP interceptors and state transfer API
  • Material 2 works on Universal
  • Write documentation for core API
  • Support AppShell use cases

In Progress

  • Better internal performance and stress tests
  • Make it easier to write unit tests for Universal components
  • Make it easier to support other 3rd part libraries like jQuery/d3 that aren't Universal aware
  • Node.js bridge protocol to communicate with different language backends - Django, Go, PHP etc.

Planning

  • Full client rehydration strategy that reuses DOM elements/CSS rendered on the server

Upgrading from Angular2-Universal

If you're coming from the original angular2-universal (2.x) here are some helpful steps for porting your application to Angular 4 & platform-server.

Go here to find the guide

Preboot

Control server-rendered page and transfer state before client-side web app loads to the client-side-app. Repo

What's in a name?

We believe that using the word "universal" is correct when referring to a JavaScript Application that runs in more environments than the browser. (inspired by Universal JavaScript)

Universal Team

License

MIT License