History

Karl Horky 3ad55721d1 Remove incorrect entries for pnpm debug log (#47241 ) Reasons for making this change: - it is contained within `node_modules/`, which is already ignored - the previous versions, which were not in `node_modules/`, did not have a period at the beginning of the filename Links to documentation supporting these rule changes: Changelog with proof here: `ba4b2db1f2/pnpm/CHANGELOG.md (L3330)` History: - my PR to remove this from `github/gitignore` here: https://github.com/github/gitignore/pull/4250 - First introduced in `github/gitignore` in https://github.com/github/gitignore/pull/3732 by `@sakurayang` (merged by `@martinwoodward`) <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation or adding/fixing Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> --------- Co-authored-by: JJ Kasper <jj@jjsweb.site>		2023-03-26 22:26:05 -07:00
..
public	Update `with-firebase-hosting[-and-typescript]` examples (#11685 )	2020-05-02 00:56:40 -04:00
src	Run next/link codemod for Next.js 13 on examples (#41913 )	2022-10-30 21:00:45 +01:00
.firebaserc	With Firebase Hosting Example (#2642 )	2017-07-26 07:52:49 +02:00
.gitignore	Remove incorrect entries for pnpm debug log (#47241 )	2023-03-26 22:26:05 -07:00
firebase.json	Update Firebase hosting example to use Node.js 14. (#27988 )	2021-08-12 21:46:23 -05:00
firebaseFunctions.js	Fix with-firebase-hosting running locally (#21971 )	2021-02-09 08:52:21 -06:00
package.json	Update Examples to use React 18 (#42027 )	2022-10-28 17:43:20 +00:00
README.md	chore(examples): reference `main` prop in README.md in Firebase example (#43434 )	2022-11-30 12:47:39 +01:00

README.md

with Firebase Hosting example

The goal is to host the Next.js app on Firebase Cloud Functions with Firebase Hosting rewrite rules so our app is served from our Firebase Hosting URL. Each individual page bundle is served in a new call to the Cloud Function which performs the initial server render.

If you are having issues, feel free to tag @jthegedus in the issue you create on the next.js repo

Make sure that firebase is set up and you have the projectID

Install Firebase Tools: npm i -g firebase-tools
Create a project through the firebase web console
Login to the Firebase CLI tool with firebase login
Grab the projectID from firebase projects:list or the web consoles URL: https://console.firebase.google.com/project/<projectID>

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-firebase-hosting with-firebase-hosting-app

yarn create next-app --example with-firebase-hosting with-firebase-hosting-app

pnpm create next-app --example with-firebase-hosting with-firebase-hosting-app

Important: Update .firebaserc and add your firebase project ID.

To run Firebase locally for testing:

npm run serve
# or
yarn serve

To deploy it to the cloud with Firebase:

npm run deploy
# or
yarn deploy

TypeScript

To use TypeScript, simply follow TypeScript setup as normal (package.json scripts are already set).

i.e: npm install --save-dev typescript @types/react @types/node

Then you can create components and pages in .tsx or .ts

Only src/next.config.js and firebaseFunctions.js must remain in *.js format.

Good to know

firebase.json outlines the catchall rewrite rule for our Cloud Function.
The empty public/.gitignore file is to ensure public/ dir exists as it is required for Firebase Hosting. It is configured (by default) that dotfiles (public/.*) are ignored from being publicly served.
The Cloud Function is named nextjsFunc (changeable in firebaseFunctions.js and firebase.json).
public/* files are statically served through Firebase hosting, not through NextJs server.

Customization

Next App is in src/ directory.

The crucial files for the setup:

.firebaserc
firebase.json
firebaseFunctions.js
src/next.config.js
In package.json: firebase-* packages, main property defining the entry point as firebaseFunctions.js