Skip to content

Commit ee0355a

Browse files
jeroenouwjeroenouw
committed
DOCS update
1 parent 081336d commit ee0355a

File tree

4 files changed

+97
-93
lines changed

4 files changed

+97
-93
lines changed

‎README.md‎

Lines changed: 11 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -8,102 +8,20 @@
88
# Angular 4 | Material Design | Firebase - Starter kit
99
A full stack starter app containing [Angular 4](https://angular.io) (v5.0.0-beta.3/v4.3.4), [Material](https://material.io/) (v2.0.0-beta.8) and [Firebase](https://firebase.google.com/) (v4.2.0).
1010

11-
12-
### Project is still in progress
13-
1411
## [Live demo](http://angular4.jerouw.nl)
15-
![loginpage](https://jerouw.nl/wp-content/uploads/2017/05/ngfbmdprintscreen.png "Logo")
16-
![githubauth](https://jerouw.nl/wp-content/uploads/2017/06/ng4githubauth.png "Logo")
17-
18-
## Quick start
19-
First clone this repo: `git clone https://github.com/jeroenouw/Angular4MaterialDesign.git`.
20-
Change directory to this project
21-
Run `npm install` to install all the dependencies.
22-
Run `npm start` or `ng serve` to run this project.
23-
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
24-
25-
To build the project run `npm run dist`.
26-
27-
## Development
28-
For own projects please use different keys in `src/app/app.component.ts`:
29-
``` firebase.initializeApp({ ```
30-
``` // For other projects use different keys```
31-
``` apiKey: '[YOUR_KEY]',```
32-
``` authDomain: '[YOUR_KEY]',```
33-
``` databaseURL: '[YOUR_KEY]',```
34-
``` projectId: '[YOUR_KEY]',```
35-
``` storageBucket: '[YOUR_KEY]',```
36-
``` messagingSenderId: '[YOUR_KEY]'```
37-
``` });```
38-
39-
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.
40-
41-
### Including in this project:
42-
* Angular 4 front-end with Material Design
43-
* Firebase back-end (0Auth authentication and NoSQL database)
44-
* Home page
45-
* About page
46-
* Contact page
47-
* Misc page
48-
* 404 page
49-
* Save email (keep in touch)
50-
* Authentication (Email, Google, Twitter, Facebook and Github)
51-
* Verification email after signup
52-
* Auth Guard
53-
* Profile
54-
* Profile image animation
55-
* Password reset
56-
* Alerts
57-
* 360 view
58-
* Multiple pipes
59-
* Carousel
60-
* Translatations
61-
* Tests
62-
* Back to top button
63-
* Loading spinner and progress bar
64-
65-
### Specific Angular 4 usage in this project:
66-
* Animations (@angular/platform-browser/animations)
67-
* ng-template
68-
* ngIf else
69-
* Titlecase pipe
70-
71-
### Specific Material Design usage in this project:
72-
* MD Datepicker
73-
* MD Input
74-
* MD Slide toggle
75-
* MD Menu
76-
* MD Sidenav
77-
* MD Toolbar
78-
* MD Table
79-
* MD Card
80-
* MD Tabs
81-
* MD Buttons
82-
* MD Icon
83-
* MD Progress spinner
84-
* MD Progress bar
85-
* MD Tooltip
86-
* MD Snackbar
12+
![loginpage](https://jerouw.nl/wp-content/uploads/2017/05/ngfbmdprintscreen.png "Logo")
8713

88-
## To Do List (development branch)
89-
* Make every component responsive
14+
## Quick start & Development
15+
[Get started now](https://github.com/jeroenouw/Angular4MaterialDesign/blob/master/docs/DEVELOPER.md)
9016

91-
## To Finish List (known issues)
92-
### Auth
93-
* Cellphone and anonymous authentication (optimizing)
94-
* Google, Facebook, Twitter & Github signin/signup
95-
* Error messages: Email already exists, login failed, registration failed
17+
## Features
18+
[Everything included in this project](https://github.com/jeroenouw/Angular4MaterialDesign/blob/master/docs/FEATURES.md)
9619

97-
### Profile
98-
* Profile image uploading
99-
* Profile settings (change settings)
100-
* Messaging layout and functionality
20+
## Future updates
21+
[To do and finish list](https://github.com/jeroenouw/Angular4MaterialDesign/blob/master/docs/TODO.md)
10122

102-
### Tests
103-
* Unit
104-
* e2e
23+
## Want to help?
24+
Want to file a bug, contribute some code, or improve documentation? Feel free to place an issue.
10525

106-
### Other
107-
* i18n translations
108-
* Internal server error 500
109-
* 360 view only working on localhost
26+
## License
27+
[MIT](https://github.com/jeroenouw/Angular4MaterialDesign/blob/master/LICENSE/)

‎docs/DEVELOPER.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Quick start
2+
First clone this repo: `git clone https://github.com/jeroenouw/Angular4MaterialDesign.git`.
3+
Change directory to this project
4+
Run `npm install` to install all the dependencies.
5+
Run `npm start` or `ng serve` to run this project.
6+
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
7+
8+
To build the project run `npm run dist`.
9+
10+
## Development
11+
For own projects please use different keys in `src/app/app.component.ts`:
12+
``` firebase.initializeApp({ ```
13+
``` // For other projects use different keys```
14+
``` apiKey: '[YOUR_KEY]',```
15+
``` authDomain: '[YOUR_KEY]',```
16+
``` databaseURL: '[YOUR_KEY]',```
17+
``` projectId: '[YOUR_KEY]',```
18+
``` storageBucket: '[YOUR_KEY]',```
19+
``` messagingSenderId: '[YOUR_KEY]'```
20+
``` });```
21+
22+
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.

‎docs/FEATURES.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Features in this project:
2+
* Angular 4 front-end with Material Design
3+
* Firebase back-end (0Auth authentication and NoSQL database)
4+
* Home page
5+
* About page
6+
* Contact page
7+
* Misc page
8+
* 404 page
9+
* Save email (keep in touch)
10+
* Authentication (Email, Google, Twitter, Facebook and Github)
11+
* Verification email after signup
12+
* Auth Guard
13+
* Profile
14+
* Profile image animation
15+
* Password reset
16+
* Alerts
17+
* 360 view
18+
* Multiple pipes
19+
* Carousel
20+
* Translatations
21+
* Tests
22+
* Back to top button
23+
* Loading spinner and progress bar
24+
25+
## Material Design usage in this project:
26+
* MD Datepicker
27+
* MD Input
28+
* MD Slide toggle
29+
* MD Menu
30+
* MD Sidenav
31+
* MD Toolbar
32+
* MD Table
33+
* MD Card
34+
* MD Tabs
35+
* MD Buttons
36+
* MD Icon
37+
* MD Progress spinner
38+
* MD Progress bar
39+
* MD Tooltip
40+
* MD Snackbar

‎docs/TODO.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
All improvements to this repo will first be done in the development branch.
2+
3+
## To Do List
4+
* Make every component responsive
5+
6+
## To Finish List (known issues)
7+
### Auth
8+
* Cellphone and anonymous authentication (optimizing)
9+
* Google, Facebook, Twitter & Github signin/signup
10+
* Error messages: Email already exists, login failed, registration failed
11+
12+
### Profile
13+
* Profile image uploading
14+
* Profile settings (change settings)
15+
* Messaging layout and functionality
16+
17+
### Tests
18+
* Unit
19+
* e2e
20+
21+
### Other
22+
* i18n translations
23+
* Internal server error 500
24+
* 360 view only working on localhost

0 commit comments

Comments
 (0)