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

chore(examples): reference main prop in README.md in Firebase example #43434

Merged
merged 4 commits into from Nov 30, 2022

Conversation

AaronJY
Copy link
Contributor

@AaronJY AaronJY commented Nov 27, 2022

Added a reference to the main property within package.json under "The crucial files for the setup:" heading.

Added a reference to the `private` property within package.json under "The crucial files for the setup:" heading
@ijjk ijjk added the examples Issue/PR related to examples label Nov 27, 2022
Copy link
Member

@balazsorban44 balazsorban44 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure I understand this:

https://github.com/AaronJY/next.js/blob/d2ee0f7227aa3b259dbae2530efa53612be52747/examples/with-firebase-hosting/package.json#L2

Here is the docs for the private property: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#private

Could you explain a bit more about what this PR does?

Change private to main (typo)
@AaronJY
Copy link
Contributor Author

AaronJY commented Nov 30, 2022

I am not sure I understand this:

https://github.com/AaronJY/next.js/blob/d2ee0f7227aa3b259dbae2530efa53612be52747/examples/with-firebase-hosting/package.json#L2

Here is the docs for the private property: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#private

Could you explain a bit more about what this PR does?

Sorry @balazsorban44, this was a really poor PR! It was quite late when I raised this and meant to type main instead of private. I've updated the README.md file to mention that the main property in package.json is important as it needs to point to firebaseFunctions.js for everything to work, and there isn't a reference to this in the docs yet.

I've updated the PR to fix the typo.

@AaronJY AaronJY changed the title Update README.md to add reference to private prop Update README.md to add reference to main prop Nov 30, 2022
@balazsorban44 balazsorban44 changed the title Update README.md to add reference to main prop chore(examples): reference main prop in README.md in Firebase example Nov 30, 2022
@balazsorban44 balazsorban44 merged commit 55e35c5 into vercel:canary Nov 30, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants