Skip to content

docs: updating config import method (environment.ts) #945

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.

Sign up for GitHub

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
May 5, 2017
Merged

docs: updating config import method (environment.ts) #945

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01f3882
docs: updating config import method (environment.ts)
markgoho May 5, 2017
7ffce15
Updating numbers
markgoho May 5, 2017
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
54 changes: 28 additions & 26 deletions docs/1-install-and-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,25 @@ npm install angularfire2 firebase --save

Now that you have a new project setup, install AngularFire2 and Firebase from npm.

### 4. Setup @NgModule for the AngularFireModule
### 4. Add Firebase config to environments variable

Open `/src/environments/environment.ts` and add your Firebase configuration:

```ts
export const environment = {
production: false,
firebase: {
apiKey: '<your-key>',
authDomain: '<your-project-authdomain>',
databaseURL: '<your-database-URL>',
projectId: '<your-project-id>',
storageBucket: '<your-storage-bucket>',
messagingSenderId: '<your-messaging-sender-id>'
}
};
```

### 5. Setup @NgModule for the AngularFireModule

Open `/src/app/app.module.ts`, inject the Firebase providers, and specify your Firebase configuration.
This can be found in your project at [the Firebase Console](https://console.firebase.google.com):
Expand All @@ -66,20 +84,12 @@ import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { AngularFireModule } from 'angularfire2';

// Must export the config
export const firebaseConfig = {
apiKey: '<your-key>',
authDomain: '<your-project-authdomain>',
databaseURL: '<your-database-URL>',
storageBucket: '<your-storage-bucket>',
messagingSenderId: '<your-messaging-sender-id>'
};
import { environment } from '../environments/environment';

@NgModule({
imports: [
BrowserModule,
AngularFireModule.initializeApp(firebaseConfig)
AngularFireModule.initializeApp(environment.firebase)
],
declarations: [ AppComponent ],
bootstrap: [ AppComponent ]
Expand All @@ -95,15 +105,15 @@ You can optionally provide a custom FirebaseApp name with `initializeApp`.
@NgModule({
imports: [
BrowserModule,
AngularFireModule.initializeApp(firebaseConfig, 'my-app-name')
AngularFireModule.initializeApp(environment.firebase, 'my-app-name')
],
declarations: [ AppComponent ],
bootstrap: [ AppComponent ]
})
export class AppModule {}
```

### 5. Setup individual @NgModules
### 6. Setup individual @NgModules

After adding the AngularFireModule you also need to add modules for the individual @NgModules that your application needs.
- AngularFireAuthModule
Expand All @@ -122,20 +132,12 @@ import { AppComponent } from './app.component';
import { AngularFireModule } from 'angularfire2';
import { AngularFireDatabaseModule } from 'angularfire2/database';
import { AngularFireAuthModule } from 'angularfire2/auth';

// Must export the config
export const firebaseConfig = {
apiKey: '<your-key>',
authDomain: '<your-project-authdomain>',
databaseURL: '<your-database-URL>',
storageBucket: '<your-storage-bucket>',
messagingSenderId: '<your-messaging-sender-id>'
};
import { environment } from '../environments/environment';

@NgModule({
imports: [
BrowserModule,
AngularFireModule.initializeApp(firebaseConfig, 'my-app-name'), // imports firebase/app needed for everything
AngularFireModule.initializeApp(environment.firebase, 'my-app-name'), // imports firebase/app needed for everything
AngularFireDatabaseModule, // imports firebase/database, only needed for database features
AngularFireAuthModule, // imports firebase/auth, only needed for auth features
],
Expand All @@ -146,7 +148,7 @@ export class AppModule {}

```

### 6. Inject AngularFireDatabase
### 7. Inject AngularFireDatabase

Open `/src/app/app.component.ts`, and make sure to modify/delete any tests to get the sample working (tests are still important, you know):

Expand All @@ -167,7 +169,7 @@ export class AppComponent {

```

### 7. Bind to a list
### 8. Bind to a list

In `/src/app/app.component.ts`:

Expand Down Expand Up @@ -198,7 +200,7 @@ Open `/src/app/app.component.html`:
</ul>
```

### 8. Run your app
### 9. Run your app

```bash
ng serve
Expand Down