Skip to content

Add prerequisites for clean install. #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 22, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/1-install-and-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

**The setups below use the [Angular CLI](https://github.com/angular/angular-cli).**

### 0. Prerequisites

```bash
npm install -g angular-cli
npm install -g typings
```

### 1. Create a new project

```bash
Expand Down
8 changes: 4 additions & 4 deletions docs/2-retrieving-data-as-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> AngularFire2 synchronizes data as objects using the `FirebaseObjectObservable`.
The `FirebaseObjectObservable` is not created by itself, but through the `AngularFire.database` service.
The guide below demonstrates how to retreive, save, and remove data as objects.
The guide below demonstrates how to retrieve, save, and remove data as objects.

## Injecting the AngularFire service

Expand All @@ -29,7 +29,7 @@ export class AppComponent {

## Create an object binding

Data is retreived through the `af.database` service.
Data is retrieved through the `af.database` service.

There are three ways to create an object binding:

Expand Down Expand Up @@ -163,15 +163,15 @@ export class RcTestAppComponent {
```

## Meta-fields on the object
Data retreived from the object binding contains special properties retreived from the unwrapped Firebase DataSnapshot.
Data retrieved from the object binding contains special properties retrieved from the unwrapped Firebase DataSnapshot.

| property | |
| ---------|--------------------|
| $key | The key for each record. This is equivalent to each record's path in our database as it would be returned by `ref.key()`.|
| $value | If the data for this child node is a primitive (number, string, or boolean), then the record itself will still be an object. The primitive value will be stored under `$value` and can be changed and saved like any other field.|


## Retreiving the snapshot
## Retrieving the snapshot
AngularFire2 unwraps the Firebase DataSnapshot by default, but you can get the data as the original snapshot by specifying the `preserveSnapshot` option.

```ts
Expand Down