Git Product home page Git Product logo

angular-universal-full-starter's Introduction

Angular Universal Angular Universal Full Starter

Angular-RU Universal

Server-Side Rendering for Angular

Table of Contents

Live Demo

angular-universal.ru (Server-Side Rendering)

Features

  • Uses Angular 6 as universal web application platform
  • Uses Angular Material 6 as UI components
  • Uses module-map-ngfactory-loader 6 as server side rendering of lazy routes
  • Uses angular/cli 6 as code scaffolder
  • Uses webpack 4 as module bundler
  • Uses node as server
  • Uses express as request handler
  • Uses ngx-translate to support internationalization (i18n)
  • Uses ngx-meta for SEO (title, meta tags, and Open Graph tags for social sharing)
  • Uses hmr (Hot Module Replacement) as hot module reloading for Webpack and Angular
  • Uses udk (Universal Development Kit) as Webpack extension which improves universal application development

Plans

  • @angular/service-worker

Getting Started

Installation

git clone https://github.com/Stivin/angular-universal.git my-project
cd my-project
npm install

Development Server

Server-Side Rendering

Run npm run dev for a universal dev server. Navigate to http://localhost:4000
The universal dev server which enable SSR (build browser and server targets)
The app will automatically hot-reload on server and browser sides if you change any of the source files.

Client-Side Rendering

Run npm run dev:spa for a SPA dev server. Navigate to http://localhost:4200
The SPA dev server which is a webpack dev server (build browser target only).
The app will automatically reload if you change any of the browser source files.

Build

Run npm run build for a build Run npm run build:prod for a production build

Universal "Gotchas"

When building Universal components in Angular there are a few things to keep in mind.

  • window, document, navigator, and other browser types - do not exist on the server - so using them, or any library that uses them (jQuery for example) will not work. You do have some options, if you truly need some of this functionality:
    • If you need to use them, consider limiting them to only your client and wrapping them situationally. You can use the Object injected using the PLATFORM_ID token to check whether the current platform is browser or server.
import { PLATFORM_ID } from '@angular/core';
import { isPlatformBrowser, isPlatformServer } from '@angular/common';

constructor(@Inject(PLATFORM_ID) private platformId: Object) { ... }

ngOnInit() {
    if (isPlatformBrowser(this.platformId)) {
        // Client only code.
        ...
    }
    if (isPlatformServer(this.platformId)) {
        // Server only code.
        ...
    }
}
- Try to *limit or* **avoid** using **`setTimeout`**. It will slow down the server-side rendering process. Make sure to remove them in the [`ngOnDestroy`](https://angular.io/docs/ts/latest/api/core/index/OnDestroy-class.html) method of your Components.
- Also for RxJs timeouts, make sure to _cancel_ their stream on success, for they can slow down rendering as well.
  • Don't manipulate the nativeElement directly. Use the Renderer2. We do this to ensure that in any environment we're able to change our view.
constructor(element: ElementRef, renderer: Renderer2) {
    renderer.setStyle(element.nativeElement, 'font-size', 'x-large');
}
  • The application runs XHR requests on the server & once again on the Client-side (when the application bootstraps)
    • Use a cache that's transferred from server to client (TODO: Point to the example)
  • Know the difference between attributes and properties in relation to the DOM.
  • Keep your directives stateless as much as possible. For stateful directives, you may need to provide an attribute that reflects the corresponding property with an initial string value such as url in img tag. For our native element the src attribute is reflected as the src property of the element type HTMLImageElement.

License

MIT License

angular-universal-full-starter's People

Contributors

stivin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

angular-universal-full-starter's Issues

angular.json udk target: move fileReplacements into server target

Initially, I wrote udk:udk-builder to accept fileReplacements because the Angular CLI wasn't support them.

It's not the case today.

Now you can move your fileReplacements declarations into server target. Be careful to use the latest syntax of Angular CLI:

        "server": {
          "builder": "@angular-devkit/build-angular:server",
          "options": {
            "outputPath": "dist/server",
            "main": "src/app/ngmodule.ts",
            "tsConfig": "src/tsconfig.server.json"
          },
          "configurations": {
            "production": {
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.prod.ts"
+                }
+              ]
            }
          }
        }

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.