generator-ngx-firebase-bootstrap

A Yeoman generator for creating projects based on Angular, Firebase and Twitter Bootstrap. This generator provides basic integration with those tools and offers a framework for authentication right out of the box.

Features

• An Angular 7 app generated with angular-cli (Angular 7.2.0)
• Twitter Bootstrap with ngx-bootstrap
• AngularFire and Firebase
• An initial implementation of an authentication service (See auth-service)
• One component to display user information
• One component to login using username/password, Google or Twitter
• One component to allow a user to register himself with username/password.
• One component for password reset (when using username/password).
• An Angular Router setup to allow navigation between the following pages of your application:
  • An All-in-one page to show all above components
  • A Home page that shows user information when logged in
  • A Dashboard page as an example of a Guarded page in your application (only available when logged in)
  • A Login page which shows the login component and the reset password component
  • A Register page which shows the register component
  • A LoggedInGuard to use in your router configuration for page that requires the user to be logged in

Now the router setup allows navigation between the pages and the components. You will just need to customize the Home page and add more pages to your own needs.

If you like and/or use this generator, please star this project on Github.

Installation

Requirement Node 10+ && NPM 6+

This generator is targeted to be used with Node >= 10.0.0 and NPM >= 6.0.0. You can check your version number with the command

$ node --version && npm --version
v10.13.0
6.5.0

Requirement Angular CLI

To build and run this project, you will need Angular CLI. This version is compatible with @angular/cli 7.2.1. If you have any previous instantiation of the Angular CLI, you should remove them.

$ npm uninstall -g angular-cli # remove any previous angular-cli
$ npm i -g @angular/cli
$ ng --version

     _                      _                 ____ _     ___
    / \   _ __   __ _ _   _| | __ _ _ __     / ___| |   |_ _|
   / △ \ | '_ \ / _` | | | | |/ _` | '__|   | |   | |    | |
  / ___ \| | | | (_| | |_| | | (_| | |      | |___| |___ | |
 /_/   \_\_| |_|\__, |\__,_|_|\__,_|_|       \____|_____|___|
                |___/


Angular CLI: 7.2.1
Node: 10.13.0
OS: darwin x64
Angular: undefined
...

Package                      Version
------------------------------------------------------
@angular-devkit/architect    0.12.1 (cli-only)
@angular-devkit/core         7.2.1 (cli-only)
@angular-devkit/schematics   7.2.1 (cli-only)
@schematics/angular          7.2.1 (cli-only)
@schematics/update           0.12.1 (cli-only)
rxjs                         6.3.3

Steps to install

First, install Yeoman and generator-ngx-firebase-bootstrap using npm (we assume you have pre-installed node.js).

$ npm install -g yo
$ npm install -g generator-ngx-firebase-bootstrap
# If you want this generator to init a git repository for you
# not supported for the moment: $ npm install -g generator-git-init

Then generate your new project:

$ yo ngx-firebase-bootstrap

Getting Started

You should have your Firebase project created in Firebase. For this, go to the Firebase Console and create a new project, in the newly created project go to 'Add Firebase to your web app'. This option will give you all the credential information you will need when generating your project. For authentication to work, you should enable the Authentication methods you want to use (See Authenticate Using Google Sign-In with JavaScript). The seeded project contains a auth-service provider that can handle several types of authentication.

Steps to scaffold a new project

1. Create a project folder and enter it: mkdir myproject && cd $_
2. Generate project: yo ngx-firebase-bootstrap

The generator will ask you a few information on your Firebase project:

• Your Api Key
• Your Auth Domain
• Your Database URL
• Your Storage Bucket
• Your Messaging SenderId

You should have those handy when you run the generator. Otherwise, you can go and fill in those values in the firebaseConfig.ts file in the generated project.

Not supported for the moment: The generator will also optionally run git init on your project and do an initial commit for you.

Squeleton of the generated app

The generated project will contain example code to authenticate to your project in Firebase. For this to actually work, you will have to enable authentication in your firebase project. The project supports Email/Password, Google Sign-In and Twitter. You could probably use Facebook and Github but we never tested that.

Go to Firebase Authentication Documentation to find out how to enable authentication for your project in Firebase. Please note that to use Email/Password authentication, so you will have to register users yourself via the Firebase Console.

The generated project will contain the following pages to help you start with your application featuring a basic router setup.

Navigation Bar

There is a Bootstrap base navigation bar provided as an example.

Login Page

The Home (when not already logged in) has a link to the Login Page which allows to Login via Twitter, Google or Email/Password. The Login page also has the Reset Password component.

Register Page

Also accessible from the Home page, the Register page shows the register component to allow ... guess what.

Home Page

When not logged in the Home Pages shows links to the Login and Register pages, otherwise, it shows user information as shown below.

Dashboard Page

The Dashboard page is an example of a proteted page in your application. The page is protected by the LoggedInGuard that checks the user is logged in before allowing access.

All-in-one Page

This page is available when not logged in and shows all available components in one convenient page.

Run the application

To run the project using Angular CLI, do the following:

$ ng serve                                                                                                                  130 ↵
** Angular Live Development Server is listening on localhost:4200, open your browser on http://localhost:4200/ **

Date: 2018-05-20T11:14:31.504Z
Hash: 4c66c7c1edfed1ce558d
Time: 14024ms
chunk {main} main.js, main.js.map (main) 83.8 kB [initial] [rendered]
chunk {runtime} runtime.js, runtime.js.map (runtime) 5.22 kB [entry] [rendered]
chunk {styles} styles.js, styles.js.map (styles) 134 kB [initial] [rendered]
chunk {vendor} vendor.js, vendor.js.map (vendor) 6.43 MB [initial] [rendered]
ℹ ｢wdm｣: Compiled successfully.

Please refer to Angular CLI documentation below.

Deploy to Firebase Hosting

To deploy your application to Firebase Hosting you should follow the instructions as explained at Deploy Your Site in the Firebase Documentation.

In a nutshell:

$ firebase init

> Choose Hosting
> Accept default database.rules.json
> Choose 'dist' as your public directory
> Enter 'yes' for rewrite all urls to index.html
> Enter 'no' for Overwriting dist/index.html

Then build your application for production with AOT.

$ ng build --prod --aot

Then deploy to Firebase.

$ firebase deploy

Angular CLI Specifics

This project was generated with Angular Cli. The project is still compatible with the CLI so you can use it to run your Development server, add more components, etc.

License

Apache-2.0 © Bernard Niset