Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
7890548
Makes e2e tests pass with SDK@3.0.0
abeisgoat Apr 27, 2016
d3bd1cc
Adds quickstart.md
abeisgoat May 9, 2016
517433b
Adds docs README.md
abeisgoat May 9, 2016
6256e91
Adds introduction-to-angularfire.md
abeisgoat May 9, 2016
a18fac5
Adds synchronized-objects.md
abeisgoat May 9, 2016
78366ef
Adds synchronized-arrays.md
abeisgoat May 9, 2016
97d70c8
Adds user-auth.md
abeisgoat May 9, 2016
c84ba13
Adds extending-services.md
abeisgoat May 9, 2016
8abb9c8
Adds beyond-angularfire.md
abeisgoat May 9, 2016
518541b
Adds migration guide
abeisgoat May 10, 2016
7dfa885
Adds Examples/Recipes
abeisgoat May 10, 2016
a186299
Fix link
abeisgoat May 10, 2016
ab06252
Upgrade to JS SDK 3.0.0
abeisgoat May 10, 2016
69b9f8d
Merge branch 'ah-docs' of github.com:firebase/angularfire
abeisgoat May 10, 2016
55ff6c2
Adds docs for 2.0
abeisgoat May 11, 2016
56f2df0
Updates CDN links
abeisgoat May 12, 2016
da1f73b
Update more CDN
abeisgoat May 12, 2016
a1da43a
Updates `new Firebase()`
abeisgoat May 12, 2016
226beaa
Fix internal link
abeisgoat May 12, 2016
1d950ac
Test fixes
abeisgoat May 18, 2016
e3245cb
More test tweaks
abeisgoat May 18, 2016
350eacd
Fix protractor js scripts
abeisgoat May 18, 2016
4b1f164
Firebase -> firebase
abeisgoat May 18, 2016
794af7a
Hack in initializeApp for e2e tests
abeisgoat May 18, 2016
ef2acbb
Testing tweaks
abeisgoat May 18, 2016
10bdb7c
Up jasmine.DEFAULT_TIMEOUT_INTERVAL
abeisgoat May 23, 2016
a89e3c5
Update more firebase.com links
abeisgoat May 23, 2016
2017852
Add link to new API ref
abeisgoat May 23, 2016
30382a6
Bump angularfire versions in docs
abeisgoat May 23, 2016
6410052
Docs updates
May 23, 2016
3cb2cc4
Re-organized main README.md
May 25, 2016
be2bfd3
Updated some more docs and links
May 26, 2016
d204700
Cleaned up tests and code *sigh*
May 27, 2016
28cbcec
Fixes protractor chat tests
abeisgoat May 27, 2016
8b0590b
Fixes protractor priority tests
abeisgoat May 27, 2016
3239243
Fixex protractor tictactoe tests
abeisgoat May 27, 2016
db93083
Various test tweaks
abeisgoat May 31, 2016
8c4f083
Remove excess console.log from tests
abeisgoat May 31, 2016
ffd7301
Typo fix (#732)
leoruhland May 31, 2016
4b52456
Fixed some bugs in code and tests
Jun 1, 2016
4c635b9
Merged with master
Jun 1, 2016
c5c8816
Added env variable to Travis
Jun 1, 2016
985e3c8
Fixed .travis.yml
Jun 1, 2016
5957609
Added issue, PR, and contributing templates / guidelines
Jun 1, 2016
5f9c240
Merged with master
Jun 1, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Contributing | AngularFire

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:

- Start with the [quickstart](../docs/quickstart.md)
- Go through the [guide](../docs/guide/README.md)
- Read the full [API reference](https://angularfire.firebaseapp.com/api.html)
- Try out some [examples](../README.md#examples)

If the official documentation doesn't help, try asking a question through our
[official support channels](https://firebase.google.com/support/).

**Please avoid double posting across multiple channels!**

see
## <a name="issue"></a>Think you found a bug?

Yeah, we're definitely not perfect!

Search through [old issues](https://github.com/firebase/angularfire/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/angularfire/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! After making sure someone hasn't already
requested the feature in the [existing issues](https://github.com/firebase/angularfire/issues), go
ahead and [open a new issue](https://github.com/firebase/angularfire/issues/new). Feel free to remove
the bug report template and instead provide an explanation of your feature request. Provide code
samples if applicable. Try to think about what it will allow you to do that you can't do today? How
will it make current workarounds straightforward? What potential bugs and edge cases does it help to
avoid?


## <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/angularfire/pull/new/master)
and fill out the provided form.

**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)
before we can accept your pull request.


## <a name="local-setup"></a>Need to get set up locally?

If you'd like to contribute to AngularFire, you'll need to do the following to get your environment
set up.

### Install Dependencies

```bash
$ git clone https://github.com/firebase/angularfire.git
$ cd angularfire # go to the angularfire directory
$ npm install -g grunt-cli # globally install grunt task runner
$ npm install # install local npm build / test dependencies
$ grunt install # install Selenium server for end-to-end tests
```

### Create a Firebase Project

1. Create a Firebase project [here](https://console.firebase.google.com).
2. Set the `ANGULARFIRE_TEST_DB_URL` environment variable to your project's database URL:

```bash
$ export ANGULARFIRE_TEST_DB_URL="https://<YOUR-DATABASE-NAME>.firebaseio.com"
```

3. Update the entire `config` variable in [`tests/initialize.js`](../tests/initialize.js) to
correspond to your Firebase project. You can find your `apiKey` and `databaseUrl` by clicking the
**Web Setup** button at `https://console.firebase.google.com/project/<projectId>/authentication/users`.

### Download a Service Account JSON File

1. Follow the instructions [here](https://firebase.google.com/docs/server/setup#add_firebase_to_your_app)
on how to create a service account for your project and furnish a private key.
2. Copy the credentials JSON file to `tests/key.json`.

### Lint, Build, and Test

```bash
$ grunt # lint, build, and test

$ grunt build # lint and build

$ gulp test # run unit and e2e tests
$ gulp test:unit # run unit tests
$ gulp test:e2e # run e2e tests (via Protractor)

$ grunt watch # lint, build, and test whenever source files change
```

The output files - `angularfire.js` and `angularfire.min.js` - are written to the `/dist/` directory.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!--

Thank you for contributing to the Firebase community!

Have a usage question?
=======================
We get lots of those and we love helping you, but GitHub is not the best place for them and they
will be closed. Here are some resources to get help:

- Start with the quickstart: https://github.com/firebase/angularfire/blob/master/docs/quickstart.md
- Go through the guide: https://github.com/firebase/angularfire/blob/master/docs/guide/README.md
- Read the full API reference: https://angularfire.firebaseapp.com/api.html
- Try out some examples: https://github.com/firebase/angularfire/blob/master/README.md#examples

If the official documentation doesn't help, try asking through our official support channels:

https://firebase.google.com/support/

*Please avoid double posting across multiple channels!*

Think you found a bug?
=======================
Yeah, we're definitely not perfect! Please use the bug report template below and include a minimal
repro when opening the issue.


Have a feature request?
========================
Great, we love hearing how we can improve our products! Just remove the template below and
provide an explanation of your feature request. Provide code samples if applicable. Try to
think about what it will allow you to do that you can't do today? How will it make current
workarounds straightforward? What potential bugs and edge cases does it help to avoid?

-->


### Version info

<!-- What versions of the following libraries are you using? Note that your issue may already
be fixed in the latest versions. -->

**Angular:**

**Firebase:**

**AngularFire:**

**Other (e.g. Node, browser, operating system) (if applicable):**

### Test case

<!-- Provide a minimal, complete, and verifiable example (http://stackoverflow.com/help/mcve)
using either Plunker (http://plnkr.co/) or JSFiddle (https://jsfiddle.net/). -->


### Steps to reproduce

<!-- Provide the steps needed to reproduce the issue given the above test case. -->


### Expected behavior

<!-- What is the expected behavior? -->


### Actual behavior

<!-- What is the actual behavior? -->
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--

Thank you for contributing to the Firebase community! Please fill out the pull request form below
and make note of the following:

Run the linter and test suite
==============================
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.

Add tests (if applicable)
==============================
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.

Sign our CLA
==============================
Please sign our Contributor License Agreement (https://cla.developers.google.com/about/google-individual)
before sending PRs. We cannot accept code without this.

-->


### Description

<!-- Are you fixing a bug? Updating our documentation? Implementing a new feature? Make sure we
have the context around your change. Link to other relevant issues or pull requests. -->

### Code sample

<!-- Proposing an API change? Provide code samples showing how the API will be used. -->
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,23 +91,5 @@ $ bower install angularfire --save

## Contributing

If you'd like to contribute to AngularFire, you'll need to run the following commands to get your
environment set up:

```bash
$ git clone https://github.com/firebase/angularfire.git
$ cd angularfire # go to the angularfire directory
$ npm install -g grunt-cli # globally install grunt task runner
$ npm install # install local npm build / test dependencies
$ grunt install # install Selenium server for end-to-end tests
$ grunt watch # watch for source file changes
```

`grunt watch` will watch for changes in the `/src/` directory and lint, concatenate, and minify the
source files when a change occurs. The output files - `angularfire.js` and `angularfire.min.js` -
are written to the `/dist/` directory. `grunt watch` will also re-run the unit tests every time you
update any source files.

You can run the entire test suite via the command line using `grunt test`. To only run the unit
tests, run `grunt test:unit`. To only run the end-to-end [Protractor](https://github.com/angular/protractor/)
tests, run `grunt test:e2e`.
If you'd like to contribute to AngularFire, please first read through our [contribution
guidelines](.github/CONTRIBUTING.md). Local setup instructions are available [here](.github/CONTRIBUTING.md#local-setup).