https://github.com/zetavg/hello-firebase
Firebase project template using TypeScript, Babel, ESLint, and Prettier. Includes "configuration as code" management, one-click deployment to Firebase, and one-click running the whole stack on local. See branches for a React web app (based on CRA) and Telegram bot (using telegraf) sample, both include one-click deployment using Firebase Hosting or Cloud Functions.
https://github.com/zetavg/hello-firebase
firebase typescript
Last synced: 2 months ago
JSON representation
Firebase project template using TypeScript, Babel, ESLint, and Prettier. Includes "configuration as code" management, one-click deployment to Firebase, and one-click running the whole stack on local. See branches for a React web app (based on CRA) and Telegram bot (using telegraf) sample, both include one-click deployment using Firebase Hosting or Cloud Functions.
- Host: GitHub
- URL: https://github.com/zetavg/hello-firebase
- Owner: zetavg
- Created: 2021-06-09T09:25:13.000Z (almost 4 years ago)
- Default Branch: react-app
- Last Pushed: 2021-06-11T20:39:57.000Z (almost 4 years ago)
- Last Synced: 2025-04-01T22:59:54.644Z (2 months ago)
- Topics: firebase, typescript
- Language: JavaScript
- Homepage:
- Size: 596 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hello Firebase
Hello Firebase project with Node.js, TypeScript, Babel, ESLint, and Prettier.
## Requirements
- [Node.js](https://nodejs.org/) 14+
- [Firebase CLI](https://firebase.google.com/docs/cli)
## Setup
Install the dependencies via:
```sh
npm install
```
Then, copy the sample config file and edit it to your needs:
```sh
cp .config.js.sample .config.js
```
At last, add and set the active Firebase project by running:
```sh
firebase use --add
```
> If you want to create a new Firebase project, run `firebase projects:create`.
## Develop
### Run Locally
Run `npm start` to start the Firebase emulators. This will prepare the runtime environment, and run the Babel compiler with Firebase emulators in parallel.
After the emulators have been started, you can access all resources shown on the console output, and also invoke HTTP functions via endpoints like `http://localhost:5001///functionName`.
> Note that the default region for functions is `us-central1`. Run `firebase use` to see the current project ID.
### Using the Functions Shell
Start the interactive shell by running: `npm run shell`.
For more information about the interactive shell, see https://firebase.google.com/docs/functions/local-shell.
## Deploy
Use `firebase use` to switch to the Firebase project you want to deploy, then run:
```sh
firebase deploy
```