-
Notifications
You must be signed in to change notification settings - Fork 0
feat:add README.md #2
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Firebase Emulator | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider adding a project title and brief description at the beginning of the README to help users understand the purpose of this repository. |
||
|
|
||
| ```bash | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be helpful to add a prerequisites section listing required tools and dependencies (Python version, Firebase CLI, etc.). |
||
| firebase emulators:start --only functions | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider adding a brief explanation of what the emulator does and why developers might want to use it for local testing. |
||
| ``` | ||
|
|
||
| ## Deploy to Firebase | ||
|
|
||
| ```bash | ||
| firebase deploy --only functions | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be beneficial to add a note about checking the deployment status and verifying the functions in the Firebase Console after deployment. |
||
| ``` | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great start for the README! To make it even more helpful for new contributors or anyone looking at the project, consider adding a main title and a short description at the top. This could explain what the project is about and what the Cloud Functions do.