Merge pull request #7 from jeroenouw/cleaning

Added compodoc, updated firebase & documentation and cleaned some code

Author: jeroenouw

.gitignore

@@ -7,6 +7,9 @@
 # dependencies
 /node_modules
 
+# compodoc documentation
+/documentation
+
 # IDEs and editors
 /.idea
 .project
@@ -30,9 +33,6 @@
 npm-debug.log
 testem.log
 /typings
-src/app/components/carousel/readme.md
-readme.txt
-todo.txt
 package-lock.json
 
 # e2e

README.md

@@ -2,28 +2,37 @@
 [![npmversion](https://img.shields.io/npm/v/ngxmatfire.svg)]()
 [![npmlicense](https://img.shields.io/npm/l/ngxmatfire.svg)](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/LICENSE/)
 [![dependencies](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/package.json)
-[![updates](https://img.shields.io/badge/updates-weekly-yellowgreen.svg)](https://github.com/jeroenouw/AngularMaterialFirebase/commits/master)
 [![stars](https://img.shields.io/github/stars/jeroenouw/AngularMaterialFirebase.svg)](https://github.com/jeroenouw/AngularMaterialFirebase/stargazers)
 [![downloads](https://img.shields.io/npm/dy/ngxmatfire.svg)]()
 
-![logo](https://jerouw.nl/wp-content/uploads/2017/05/ngfbmd.png "Logo")  
+![logo](https://jerouw.nl/wp-content/uploads/2017/05/ngfbmd.png "Logo")
 
 # Angular 6 | Material Design | Firebase - Starter kit
+
 A full stack starter app containing [Angular 6](https://angular.io), [Material](https://material.io/) and [Firebase](https://firebase.google.com/).
 
-## [Live demo](http://ngxmatfire.jerouw.nl) 
-![loginpage](https://jerouw.nl/wp-content/uploads/2017/05/ngfbmdprintscreen.png "Logo")  
+## [Live demo](http://ngxmatfire.jerouw.nl)
+
+![loginpage](https://jerouw.nl/wp-content/uploads/2017/05/ngfbmdprintscreen.png "Logo")
 
 ## Quick start, Development & Production
-[Get started now](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/DEVELOPER.md)  
+
+[Get started now](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/DEVELOPER.md)
 
 ## Features
-[Everything included in this project](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/FEATURES.md)  
+
+[Everything included in this project](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/FEATURES.md)
+
+## Compodoc
+
+[Generate technical documentation automatically](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/COMPODOC.md)
 
 ## Future updates
-[To do and finish list](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/TODO.md)  
+
+[To do and finish list](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/TODO.md)
 
 ## Contributing
+
 Want to file a bug, contribute some code, or improve documentation? Feel free to place an [issue](https://github.com/jeroenouw/AngularMaterialFirebase/issues).
 
 ## License

angular.json

@@ -7,6 +7,7 @@
       "root": "",
       "sourceRoot": "src",
       "projectType": "application",
+      "prefix": "app",
       "schematics": {},
       "architect": {
         "build": {

docs/COMPODOC.md

@@ -0,0 +1,23 @@
+# Compodoc automated documentation
+
+[Compodoc](https://compodoc.github.io/website/) is a documentation tool for Angular applications. It generates a static documentation of your application. Others developers of your team, or internet visitors for a public documentation, can easily understand the features of your application or library.
+
+## How to run
+
+Generate documentation.
+
+```cmd
+npm run compodoc:g
+```
+
+Generate documentation and serve on `http://localhost:8080`.
+
+```cmd
+npm run compodoc:s
+```
+
+Generate documentation, serve on `http://localhost:8080` and watch changes.
+
+```cmd
+npm run compodoc:w
+```

docs/DEVELOPER.md

@@ -1,27 +1,37 @@
+# DEVELOPER
+
 ## Quick start
+
 First clone this repo: `git clone https://github.com/jeroenouw/AngularMaterialFirebase.git`.  
 Change directory to this project  
 Run `npm install` to install all the dependencies.  
-Run `npm start` to run this project. This will run with the AoT Compiler.    
+Run `npm start` to run this project. This will run with the AoT Compiler.  
 Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.  
 
 ## Development
+
 For own projects please use different keys in `src/app/app.component.ts`:  
-``` firebase.initializeApp({ ```   
-```     // For other projects use different keys```  
-```    apiKey: '[YOUR_KEY]',```  
-```     authDomain: '[YOUR_KEY]',```  
-```    databaseURL: '[YOUR_KEY]',```  
-```    projectId: '[YOUR_KEY]',```  
-```   storageBucket: '[YOUR_KEY]',```    
-```  messagingSenderId: '[YOUR_KEY]'```  
-```    });```  
-  
+
+```typescript
+
+firebase.initializeApp({
+  // For other projects use different keys
+  apiKey: '[YOUR_KEY]',
+  authDomain: '[YOUR_KEY]',
+  databaseURL: '[YOUR_KEY]',
+  projectId: '[YOUR_KEY]',
+  storageBucket: '[YOUR_KEY]',
+  messagingSenderId: '[YOUR_KEY]'
+});
+
+```
+
 Run `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.  
 
 To build the development environment, run `npm run dist`.
 
 ## Production
-To build the default production environment, run `npm run prod`. This will run with the AoT Compiler.   
-To build the production environment with reduced file size, run `npm run prod:opt` (Takes extra time to build with build optimizer).  
 
+To build the production environment, run `npm run prod`. This will run with the AoT Compiler.  
+To build the production environment without hashing in the files, run `npm run prod:hashless`. This will give packages without a hash.  
+To build the production environment with reduced file size, run `npm run prod:opt` (Takes extra time to build with build optimizer).  

docs/FEATURES.md

@@ -1,6 +1,10 @@
-## Features in this project:
+# FEATURES
+
+## Features in this project
+
 * Angular 6 front-end with Material Design
 * Firebase back-end (0Auth authentication and NoSQL database)
+* Automated documentation (compodoc)
 * Home page
 * About page
 * Contact page
@@ -23,7 +27,8 @@
 * Back to top button
 * Loading spinner and progress bar
 
-## Material Design usage in this project:
+## Material Design usage in this project
+
 * Mat Datepicker
 * Mat Input
 * Mat Slide toggle

docs/TODO.md

@@ -1,22 +1,31 @@
-All improvements to this repo will first be done in the development branch.
+# TODO
 
-## To Do List 
-* Make every component responsive (flex-layout)
+All improvements to this repo will first be done in a sub branch.
+
+## To Do List
+
+* Make every component responsive (@angular/flex-layout)
+* Add Bazel
+* Add Closure
 
 ## To Finish List (known issues)
+
 ### Auth
+
 * Cellphone authentication (optimizing)
 * Google, Facebook, Twitter & Github signin/signup
-* Error messages: Email already exists, login failed, registration failed
+* Error messages (email already exists, login failed, registration failed)
 
 ### Profile
+
 * Profile image uploading
 * Messaging layout and functionality
 
 ### Tests
+
 * Unit
 * e2e
 
 ### Other
-* i18n translations
+
 * 360 view only working on localhost