docs: refresh quickstart and README for current ng add and deploy paths - #3736
Open
armando-navarro wants to merge 1 commit into
Open
docs: refresh quickstart and README for current ng add and deploy paths#3736armando-navarro wants to merge 1 commit into
armando-navarro wants to merge 1 commit into
Conversation
The quickstart described the pre-v7 ng add (environment files and AngularFireModule) and told users to run ng deploy, which no longer works on a fresh project. Correct step 2 to what ng add writes today (provideFirebaseApp in the app config, no environment files), fix the scaffold file and class names to app.ts and class App, type the Firestore binding with an Item interface, and split step 6 into the client-rendered path (Firebase Hosting) and the server-rendered path (App Hosting). Add a Before you begin section covering the @next requirement on the newest Angular major, the Firebase CLI, and the harmless CLI prompts. README: drop the obsolete single-command deploy bullet, remove the developer-preview disclaimer, fix the appConfig example (brace and missing imports), alphabetize the product-integrations table, and make the Stackblitz note template-agnostic.
armando-navarro
added
comp: docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist
yarn install,yarn testrun successfully?: not applicable, no code changedDescription
Refreshes the Quickstart (
docs/install-and-setup.md) and the README so they match how a current Angular app is created and howng add @angular/firebehaves today.ng addactually does (writesprovideFirebaseApp(...)into the app configuration with the config inlined, no environment files).app.tsand classApp,templateUrl/styleUrl), and type the Firestore binding with anIteminterface.ng deploystep with guidance for both paths: Firebase Hosting for client-rendered apps, and Firebase App Hosting for server-rendered apps.@nextrequirement on the newest Angular major, the Firebase CLI, and the harmless setup prompts.Documentation only, no source or API changes.
Fixes #3735
Refs #3667