Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document migration of universal repo #3251

Merged
merged 1 commit into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 0 additions & 67 deletions .github/ISSUE_TEMPLATE/Bug.md

This file was deleted.

26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/Feature_Request.md

This file was deleted.

12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/Proposal.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Bugs and feature requests
url: https://github.com/angular/angular-cli/issues/new
about: Report an issue in Angular Universal in the Angular CLI repository.
- name: Support request
url: https://github.com/angular/angular-cli/blob/main/CONTRIBUTING.md#question
about: Questions and requests for support.
71 changes: 2 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,5 @@
[![CircleCI](https://circleci.com/gh/angular/universal/tree/main.svg?style=shield)](https://circleci.com/gh/angular/universal/tree/main)
[![Join the chat at https://gitter.im/angular/universal](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/angular/universal?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# Angular Universal

![Angular Universal](https://angular.io/generated/images/marketing/concept-icons/universal.png)

# Table of Contents

- [Introduction](#introduction)
- [Getting Started with Universal](#getting-started)
- [Packages](#packages)
- [Universal "Gotchas"](#universal-gotchas)
- [Preboot](#preboot)
- [What's in a name?](#whats-in-a-name)
- [Universal Team](#universal-team)
- [License](#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 check [our contributing guidelines](https://github.com/angular/universal/blob/main/CONTRIBUTING.md) and send us your Pull Requests!

# Getting Started

[Angular Universal Guide](https://angular.io/guide/universal)

# Packages

The packages from this repo are published as scoped packages under [@nguniversal](https://www.npmjs.com/search?q=%40nguniversal)

- [@nguniversal/common](/modules/common/README.md)
- [@nguniversal/builders](/modules/builders/README.md)
- [@nguniversal/express-engine](/modules/express-engine/README.md)

# Universal "Gotchas"

Moved to [/docs/gotchas.md](/docs/gotchas.md)

# Preboot

Control server-rendered page and transfer state before client-side web app loads to the client-side-app. [Repo](https://github.com/angular/preboot)

# 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](https://medium.com/@mjackson/universal-javascript-4761051b7ae9))

# Universal Team

- [Adam Plumer](https://github.com/CaerusKaru) and [Fabian Wiles](https://github.com/Toxicable) - Current maintainers
- [PatrickJS](https://twitter.com/gdi2290) and [Jeff Whelpley](https://twitter.com/jeffwhelpley) - Founders of the Angular Universal project. (Universal rendering is also called [PatrickJS-ing](https://twitter.com/jeffbcross/status/846512930971516928))
- [Mark Pieszak](https://twitter.com/MarkPieszak) - Core team
- [Wassim Chegham](https://twitter.com/manekinekko) - Contributor & Evangelist
- [Jason Jean](https://github.com/FrozenPandaz) - Express engine and Universal support for CLI
- [Jeff Cross](https://twitter.com/jeffbcross) - Evangelist and performance consultant
- [Douglas Parker](https://github.com/dgp1130) and [Alex Rickabaugh](https://github.com/alxhub) - Angular Core API

# Community Resources

- [Angular Universal - Server-side Rendering Deep Dive](https://trilon.io/blog/angular-universal-server-side-rendering-deep-dive)
- [Angular Universal v9 - what's new?](https://trilon.io/blog/angular-universal-v9-whats-new)
- [Angular for the rest of us](https://medium.com/google-developer-experts/angular-universal-for-the-rest-of-us-922ca8bac84)
- [Angular outside the browser](https://slides.com/wassimchegham/angular2-universal#/)

# License
## This repository has been moved to Angular CLI repo

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](/LICENSE)
You can find the Angular CLI repo [here](https://github.com/angular/angular-cli).