Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robisim74/firebase-functions-typescript-starter
Create & test Firebase Cloud Functions in TypeScript
https://github.com/robisim74/firebase-functions-typescript-starter
firebase firebase-cloud-functions mocha rollup typescript
Last synced: 3 months ago
JSON representation
Create & test Firebase Cloud Functions in TypeScript
- Host: GitHub
- URL: https://github.com/robisim74/firebase-functions-typescript-starter
- Owner: robisim74
- License: mit
- Created: 2018-01-13T16:29:50.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-08T21:38:34.000Z (about 3 years ago)
- Last Synced: 2024-10-01T05:51:46.042Z (3 months ago)
- Topics: firebase, firebase-cloud-functions, mocha, rollup, typescript
- Language: TypeScript
- Homepage:
- Size: 223 KB
- Stars: 106
- Watchers: 7
- Forks: 30
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Firebase Functions TypeScript starter
>Create & test Firebase Cloud Functions in TypeScript
This starter allows you to create & test **Firebase Cloud Functions** in _TypeScript_.
Get the [Changelog](https://github.com/robisim74/firebase-functions-typescript-starter/blob/master/CHANGELOG.md).
## Contents
* [1 Project structure](#1)
* [2 Customizing](#2)
* [3 Testing](#3)
* [4 Building](#4)
* [5 Publishing](#5)
* [6 What it is important to know](#6)
## 1 Project structure
- **functions**:
- **src** folder for the Functions
- **index.ts** entry point for all your Firebase Functions
- **tests** folder for the _Mocha_ tests
- **package.json** _npm_ options
- **rollup.config.js** _Rollup_ configuration for building the ES bundle
- **tsconfig.json** _TypeScript_ compiler options
- **.mocharc.json** _Mocha_ options
- **.eslintrc.json** _ESLint_ configuration
- **.firebaserc**: Firebase projects
## 2 Customizing
1. Update [Firebase CLI](https://github.com/firebase/firebase-tools).
2. Update `.firebaserc` with your `project-id`.
3. Add your Firebase Functions to `index.ts` and create different files for each one.
4. Update in `rollup.config.js` file external dependencies with those that actually you use to build the ES bundle.
5. Create unit tests in `tests` folder.
## 3 Testing
The following command runs unit tests using _Mocha_ that are in the `tests` folder:
```Shell
npm test
```
## 4 Building
#### Development
Start _tsc_ compiler with _watch_ option:
```Shell
npm run build:dev
```
Start the emulator _firebase emulators:start --only functions_
```Shell
npm run serve:dev
```
For the other supported emulators, please refer to the official documentation: [
Run Functions Locally](https://firebase.google.com/docs/functions/local-emulator)
#### Production
The following command:
```Shell
npm run build
```
creates `lib` folder with the file of distribution:
```
└── functions
└──lib
└── index.js
```
## 5 Publishing
```Shell
npm run deploy
```
## 6 What it is important to know
1. _Node.js_
The engine in `package.json` is set to _Node.js 16_
2. ES Modules
_Node.js 16_ supports ES Modules: so you have `"type": "module"` in `package.json`, `format: 'es'` in `rollup.config.js` and `tsconfig.js` used by _tsc_ compiler targets ES2021 with ES2020 modules
3. Bundling with _Rollup_
_Firebase Cloud Functions_ do not require the deployment of a single bundle. In any case the building with _Rollup_ offers some advantages:
* _Tree shaking_ of unused code
* No request for other files at runtime
## License
MIT