Skip to content

Commit c71f82b

Browse files
committed
Updated documentation
1 parent 7f363bc commit c71f82b

File tree

4 files changed

+23
-21
lines changed

4 files changed

+23
-21
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ A full stack starter app containing [Angular 7](https://angular.io), [Material](
2323

2424
[Everything included in this project](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/FEATURES.md)
2525

26-
## Compodoc
26+
## Automated documentation
2727

28-
[Generate technical documentation automatically](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/COMPODOC.md)
28+
[Generate technical documentation automatically with Compodoc](https://github.com/jeroenouw/AngularMaterialFirebase/blob/master/docs/COMPODOC.md)
2929

3030
## Future updates
3131

docs/DEVELOPER.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Change directory to this project
77
Run `npm install` to install all the dependencies.
88
Run `npm start` to run this project. This will run with the AoT Compiler.
99
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
10+
Run `npm reset` if you want to install everything again.
1011

1112
## Development
1213

@@ -15,13 +16,13 @@ For own projects please use different keys in `src/app/app.component.ts`:
1516
```typescript
1617

1718
firebase.initializeApp({
18-
// For other projects use different keys
19-
apiKey: '[YOUR_KEY]',
20-
authDomain: '[YOUR_KEY]',
21-
databaseURL: '[YOUR_KEY]',
22-
projectId: '[YOUR_KEY]',
23-
storageBucket: '[YOUR_KEY]',
24-
messagingSenderId: '[YOUR_KEY]'
19+
// For your own projects use different keys
20+
apiKey: 'YOUR_KEY',
21+
authDomain: 'YOUR_DOMAIN',
22+
databaseURL: 'YOUR_URL',
23+
projectId: 'YOUR_ID',
24+
storageBucket: 'YOUR_KEY',
25+
messagingSenderId: 'YOUR_ID'
2526
});
2627

2728
```
@@ -34,4 +35,4 @@ To build the development environment, run `npm run dist`.
3435

3536
To build the production environment, run `npm run prod`. This will run with the AoT Compiler.
3637
To build the production environment without hashing in the files, run `npm run prod:hashless`. This will give packages without a hash.
37-
To build the production environment with reduced file size, run `npm run prod:opt` (Takes extra time to build with build optimizer).
38+
Also available: run `npm run prod:src`.

docs/FEATURES.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,32 @@
22

33
## Features in this project
44

5-
* Angular 7 front-end with Material Design
6-
* Firebase back-end (0Auth authentication and NoSQL database)
5+
* Angular 7 front-end
6+
* Material Design
7+
* Firebase back-end (OAuth authentication and NoSQL database)
78
* Automated documentation (compodoc)
89
* Home page
910
* About page
1011
* Contact page
1112
* Misc page
1213
* 404 page
14+
* Profile page
15+
* Profile settings page
16+
* Login page
17+
* Signup page
1318
* Save email (keep in touch)
1419
* Authentication (Anonymous, Email, Google, Twitter, Facebook and Github)
1520
* Verification email after signup
1621
* Auth Guard
17-
* Profile
1822
* Profile image animation
19-
* Profile settings
2023
* Password reset
2124
* Alerts
2225
* 360 view
2326
* Multiple pipes
27+
* Various components to use
2428
* Carousel
25-
* Translatations
26-
* Tests
2729
* Back to top button
28-
* Loading spinner and progress bar
30+
* Loading spinner and/or progress bar
2931

3032
## Material Design usage in this project
3133

docs/TODO.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@ All improvements to this repo will first be done in a sub branch.
44

55
## To Do List
66

7-
* Make every component responsive (@angular/flex-layout)
8-
* Add Bazel
9-
* Add Closure
7+
* Make every component responsive (@angular/flex-layout?)
8+
* Messaging
109

1110
## To Finish List (known issues)
1211

1312
### Auth
1413

1514
* Cellphone authentication (optimizing)
15+
* Session
1616
* Google, Facebook, Twitter & Github signin/signup
1717
* Error messages (email already exists, login failed, registration failed)
1818

1919
### Profile
2020

2121
* Profile image uploading
22-
* Messaging layout and functionality
2322

2423
### Tests
2524

0 commit comments

Comments
 (0)