| 1 | [](https://github.com/firebase/firebase-admin-node/actions)
|
| 2 |
|
| 3 | # Firebase Admin Node.js SDK
|
| 4 |
|
| 5 |
|
| 6 | ## Table of Contents
|
| 7 |
|
| 8 | * [Overview](#overview)
|
| 9 | * [Installation](#installation)
|
| 10 | * [Contributing](#contributing)
|
| 11 | * [Documentation](#documentation)
|
| 12 | * [Supported Environments](#supported-environments)
|
| 13 | * [Acknowledgments](#acknowledgments)
|
| 14 | * [License](#license)
|
| 15 |
|
| 16 |
|
| 17 | ## Overview
|
| 18 |
|
| 19 | [Firebase](https://firebase.google.com) provides the tools and infrastructure
|
| 20 | you need to develop your app, grow your user base, and earn money. The Firebase
|
| 21 | Admin Node.js SDK enables access to Firebase services from privileged environments
|
| 22 | (such as servers or cloud) in Node.js.
|
| 23 |
|
| 24 | For more information, visit the
|
| 25 | [Firebase Admin SDK setup guide](https://firebase.google.com/docs/admin/setup/).
|
| 26 |
|
| 27 |
|
| 28 | ## Installation
|
| 29 |
|
| 30 | The Firebase Admin Node.js SDK is available on npm as `firebase-admin`:
|
| 31 |
|
| 32 | ```bash
|
| 33 | $ npm install --save firebase-admin
|
| 34 | ```
|
| 35 |
|
| 36 | To use the module in your application, `require` it from any JavaScript file:
|
| 37 |
|
| 38 | ```js
|
| 39 | const { initializeApp } = require("firebase-admin/app");
|
| 40 |
|
| 41 | initializeApp();
|
| 42 | ```
|
| 43 |
|
| 44 | If you are using ES2015, you can `import` the module instead:
|
| 45 |
|
| 46 | ```js
|
| 47 | import { initializeApp } from "firebase-admin/app";
|
| 48 |
|
| 49 | initializeApp();
|
| 50 | ```
|
| 51 |
|
| 52 |
|
| 53 | ## Contributing
|
| 54 |
|
| 55 | Please refer to the [CONTRIBUTING page](./CONTRIBUTING.md) for more information
|
| 56 | about how you can contribute to this project. We welcome bug reports, feature
|
| 57 | requests, code review feedback, and also pull requests.
|
| 58 |
|
| 59 |
|
| 60 | ## Supported Environments
|
| 61 |
|
| 62 | We support Node.js 12 and higher.
|
| 63 |
|
| 64 | Please also note that the Admin SDK should only
|
| 65 | be used in server-side/back-end environments controlled by the app developer.
|
| 66 | This includes most server and serverless platforms (both on-premise and in
|
| 67 | the cloud). It is not recommended to use the Admin SDK in client-side
|
| 68 | environments.
|
| 69 |
|
| 70 |
|
| 71 | ## Documentation
|
| 72 |
|
| 73 | * [Setup Guide](https://firebase.google.com/docs/admin/setup/)
|
| 74 | * [Database Guide](https://firebase.google.com/docs/database/admin/start/)
|
| 75 | * [Authentication Guide](https://firebase.google.com/docs/auth/admin/)
|
| 76 | * [Cloud Messaging Guide](https://firebase.google.com/docs/cloud-messaging/admin/)
|
| 77 | * [API Reference](https://firebase.google.com/docs/reference/admin/node/)
|
| 78 | * [Release Notes](https://firebase.google.com/support/release-notes/admin/node/)
|
| 79 |
|
| 80 |
|
| 81 | ## Acknowledgments
|
| 82 |
|
| 83 | Thanks to the team at [Casetext](https://casetext.com/) for transferring
|
| 84 | ownership of the `firebase-admin` npm module over to the Firebase team
|
| 85 | and for their longtime use and support of the Firebase platform.
|
| 86 |
|
| 87 |
|
| 88 | ## License
|
| 89 |
|
| 90 | Firebase Admin Node.js SDK is licensed under the
|
| 91 | [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
| 92 |
|
| 93 | Your use of Firebase is governed by the
|
| 94 | [Terms of Service for Firebase Services](https://firebase.google.com/terms/).
|