forked from firebase/firebase-admin-node
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Hiranya Jayathilaka
committed
May 4, 2017
0 parents
commit 608687d
Showing
58 changed files
with
15,244 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
.idea | ||
.DS_Store | ||
npm-debug.log | ||
|
||
lib/ | ||
.tmp/ | ||
typings/ | ||
coverage/ | ||
node_modules/ | ||
|
||
# Real key file should not be checked in | ||
test/resources/key.json | ||
|
||
# Release tarballs should not be checked in | ||
firebase-admin-*.tgz |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
# Contributing | Firebase Admin Node.js SDK | ||
|
||
Thank you for contributing to the Firebase community! | ||
|
||
- [Have a usage question?](#question) | ||
- [Think you found a bug?](#issue) | ||
- [Have a feature request?](#feature) | ||
- [Want to submit a pull request?](#submit) | ||
- [Need to get set up locally?](#local-setup) | ||
|
||
|
||
## <a name="question"></a>Have a usage question? | ||
|
||
We get lots of those and we love helping you, but GitHub is not the best place for them. Issues | ||
which just ask about usage will be closed. Here are some resources to get help: | ||
|
||
- Go through the [guides](https://firebase.google.com/docs/admin/setup/) | ||
- Read the full [API reference](https://firebase.google.com/docs/reference/admin/node/) | ||
|
||
If the official documentation doesn't help, try asking a question on the | ||
[Firebase Google Group](https://groups.google.com/forum/#!forum/firebase-talk/) or one of our | ||
other [official support channels](https://firebase.google.com/support/). | ||
|
||
**Please avoid double posting across multiple channels!** | ||
|
||
|
||
## <a name="issue"></a>Think you found a bug? | ||
|
||
Yeah, we're definitely not perfect! | ||
|
||
Search through [old issues](https://github.com/firebase/firebase-admin-node/issues) before | ||
submitting a new issue as your question may have already been answered. | ||
|
||
If your issue appears to be a bug, and hasn't been reported, | ||
[open a new issue](https://github.com/firebase/firebase-admin-node/issues/new). Please use the | ||
provided bug report template and include a minimal repro. | ||
|
||
If you are up to the challenge, [submit a pull request](#submit) with a fix! | ||
|
||
|
||
## <a name="feature"></a>Have a feature request? | ||
|
||
Great, we love hearing how we can improve our products! Share you idea through our | ||
[feature request support channel](https://firebase.google.com/support/contact/bugs-features/). | ||
|
||
|
||
## <a name="submit"></a>Want to submit a pull request? | ||
|
||
Sweet, we'd love to accept your contribution! | ||
[Open a new pull request](https://github.com/firebase/firebase-admin-node/pull/new/master) and fill | ||
out the provided template. | ||
|
||
**If you want to implement a new feature, please open an issue with a proposal first so that we can | ||
figure out if the feature makes sense and how it will work.** | ||
|
||
Make sure your changes pass our linter and the tests all pass on your local machine. We've hooked | ||
up this repo with continuous integration to double check those things for you. | ||
|
||
Most non-trivial changes should include some extra test coverage. If you aren't sure how to add | ||
tests, feel free to submit regardless and ask us for some advice. | ||
|
||
Finally, you will need to sign our | ||
[Contributor License Agreement](https://cla.developers.google.com/about/google-individual), | ||
and go through our code review process before we can accept your pull request. | ||
|
||
### Contributor License Agreement | ||
|
||
Contributions to this project must be accompanied by a Contributor License | ||
Agreement. You (or your employer) retain the copyright to your contribution. | ||
This simply gives us permission to use and redistribute your contributions as | ||
part of the project. Head over to <https://cla.developers.google.com/> to see | ||
your current agreements on file or to sign a new one. | ||
|
||
You generally only need to submit a CLA once, so if you've already submitted one | ||
(even if it was for a different project), you probably don't need to do it | ||
again. | ||
|
||
### Code reviews | ||
|
||
All submissions, including submissions by project members, require review. We | ||
use GitHub pull requests for this purpose. Consult | ||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more | ||
information on using pull requests. | ||
|
||
|
||
## <a name="local-setup"></a>Need to get set up locally? | ||
|
||
### Initial Setup | ||
|
||
Run the following commands from the command line to get your local environment set up: | ||
|
||
```bash | ||
$ git clone https://github.com/firebase/firebase-admin-node.git | ||
$ cd firebase-admin-node # go to the firebase-admin-node directory | ||
$ npm install -g gulp # globally install gulp task runner | ||
$ npm install # install local npm build / test dependencies | ||
``` | ||
|
||
In order to run the tests, you also need to | ||
[download the `gcloud` CLI](https://cloud.google.com/sdk/downloads), run the following command, and | ||
follow the prompts: | ||
|
||
```bash | ||
$ gcloud beta auth application-default login | ||
``` | ||
|
||
### Lint, Build, and Test | ||
|
||
Source files are written in [TypeScript](https://www.typescriptlang.org/) and linted using | ||
[TSLint](https://palantir.github.io/tslint/). Tests are run on the compiled JavaScript files. | ||
|
||
The lint, build, and test process is kicked off via the default `gulp` task, although you can also | ||
run each task individually: | ||
|
||
```bash | ||
$ gulp # Lint, build, and test | ||
$ gulp lint # Just lint | ||
$ gulp build # Just build | ||
$ gulp test # Just test | ||
``` | ||
|
||
### Running Tests | ||
|
||
There are two test suites: unit and integration. The unit test suite is intended to be run during | ||
development and the integration test suite is intended to be run before packaging up release | ||
candidates. | ||
|
||
To run the unit test suite: | ||
|
||
``` | ||
$ gulp # Lint, build, and run unit test suite | ||
``` | ||
|
||
To run the integration test suite: | ||
|
||
``` | ||
$ node test/integration # Run integration test suite | ||
``` | ||
|
||
The integration test suite requires you to generate a service account key JSON file for the | ||
**admin-sdks-test** Firebase project and save it to `test/resources/key.json`. You can generate this | ||
from the | ||
[**Service Accounts**](https://console.firebase.google.com/project/admin-sdks-test/settings/serviceaccounts/adminsdk) | ||
tab of that project's settings page. | ||
|
||
### Repo Organization | ||
|
||
Here are some highlights of the directory structure and notable source files | ||
|
||
* `src/` - Source directory, written in TypeScript. | ||
* `auth/` - Auth source files, including the user management, credential, and token generator | ||
APIs. | ||
* `database/` - Database source files, imported as a minified JavaScript file from a separate | ||
repo. | ||
* `messaging/` - Messaging source files, including the FCM send APIs. | ||
* `utils/` - Utilities for doing things such as sending requests, handling errors, and validating | ||
inputs. | ||
* `index.ts` - Main SDK entry point which registers the Firebase services. | ||
* `index.d.ts` - Hand-crafted TypeScript declaration file. | ||
* `firebase-app.ts` - `FirebaseApp` implementation. | ||
* `firebase-namespace.ts` - `FirebaseNamespace` implementation. | ||
* `default-namespace.ts` - Exports a `FirebaseNamespace` instance which acts as the top-level SDK | ||
export. | ||
* `lib/` - Output directory for all compiled files. | ||
* `test/` - Unit and integration test suites. | ||
* `unit/` - Unit test suite written in Mocha which extensively tests the source code using mocks | ||
for all network requests. | ||
* `index.spec.js` - Main unit test entry point which imports the tests to be run. | ||
* `utils.js` - Testing utilities. | ||
* `integration/` - Integration test suite which actually hits live Firebase services. | ||
* `resources/` - Provides mocks for several variables as well as mock service account keys. | ||
* `.github/` - Contribution instructions as well as issue and pull request templates. | ||
* `createReleaseTarball.sh` - Generates a new release tarball and ensures it passes all tests. | ||
* `gulpfile.js` - Defines the `gulp` tasks. | ||
* `tslint.json` - TypeScript linting rules. | ||
* `tsconfig.json` - TypeScript configuration options. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
### [READ] Step 1: Are you in the right place? | ||
|
||
* For issues or feature requests related to __the code in this repository__ | ||
file a Github issue. | ||
* If this is a __feature request__ make sure the issue title starts with "FR:". | ||
* For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/) | ||
with the firebase tag. | ||
* For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk) | ||
google group. | ||
* For help troubleshooting your application that does not fall under one | ||
of the above categories, reach out to the personalized | ||
[Firebase support channel](https://firebase.google.com/support/). | ||
|
||
### [REQUIRED] Step 2: Describe your environment | ||
|
||
* Operating System version: _____ | ||
* Firebase SDK version: _____ | ||
* Library version: _____ | ||
* Firebase Product: _____ (auth, database, storage, etc) | ||
|
||
### [REQUIRED] Step 3: Describe the problem | ||
|
||
#### Steps to reproduce: | ||
|
||
What happened? How can we make the problem occur? | ||
This could be a description, log/console output, etc. | ||
|
||
#### Relevant Code: | ||
|
||
``` | ||
// TODO(you): code here to reproduce the problem | ||
``` |
Oops, something went wrong.