Angular Universal
Table of Contents
- Introduction
- Getting Started with Universal
- w/ NodeJS Server
- w/ ASP.NET Core Server
- Packages
- Universal "Gotchas"
- Roadmap
- Upgrading from Angular2-Universal
- Preboot
- What's in a name?
- Universal Team
- License
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
- 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
- @nguniversal/common
- @nguniversal/express-engine
- @nguniversal/aspnetcore-engine
- @nguniversal/hapi-engine
- @nguniversal/module-map-ngfactory-loader
- @nguniversal/socket-engine
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.
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
- Adam Plumer and Fabian Wiles - Current maintainers
- PatrickJS and Jeff Whelpley - Founders of the Angular Universal project. (Universal rendering is also called PatrickJS-ing)
- Mark Pieszak - Contributor and Evangelist, ASP.NET Core Engine
- Jason Jean - Express engine and Universal support for CLI
- Wassim Chegham - Contributor and Evangelist, Hapi engine developer.
- Jeff Cross - Evangelist and performance consultant
- Vikram Subramanian and Alex Rickabaugh - Angular Core API
