/example/README.md doesn't mention creating an app first
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- firebase, javascript, react
- Domain
- documentation
Research direction
Start with /example/README.md and reproduce the setup through npm run build, checking the generated firebase-config.json and the App.jsx:10 error. Update the README to cover creating a web app with firebase apps:create and checking existing apps with firebase apps:list; done means a new reader can complete the example without the reported runtime error.
Written by the indexing model from the issue text.
Description
I followed example README.md exactly, and result was the example didn't work, with a runtime JS error:
Uncaught TypeError: Cannot read properties of undefined (reading 'sdkConfig')
at Object.<anonymous> (App.jsx:10:58)
Cause of the above is npm run build produced firebase-config.json that contained an error (with misleading message, firebase/firebase-tools/issues/4007) because I hadn't created a "web" app yet in the Firebase project.
The readme, since it has readers create a new Firebase project, should include a firebase apps:create invocation, to ensure there's a web app available. Could also mention using firebase apps:list, in case the Firebase project is not new, already has 2 apps, which I presume causes the same error(?) - I can imagine people trying to use most of these steps with an existing project.
- Dominant language
- JavaScript
- Stars
- 1.3k
- Forks
- 246
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from firebase/firebaseui-web-react
-
This Project Is Dead Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
firebase/firebaseui-web-react#292 · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 1/100
firebase/firebaseui-web-react#280 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
firebase/firebaseui-web-react#220 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
firebase/firebaseui-web-react#210 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
firebase/firebaseui-web-react#201 · 1 comment · 1 reaction ·
All issues in firebase/firebaseui-web-react
Similar issues
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
open-webui/open-webui#30750 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 70/100