Skip to content

Commit 869647c

Browse files
Awk34gitbook-bot
authored andcommitted
GitBook: [master] 3 pages and 9 assets modified
1 parent d55dca8 commit 869647c

12 files changed

+9089
-50
lines changed

.gitbook/assets/angular-fullstack-logo.svg

+9,045
Loading

.gitbook/assets/image (1).png

-141 KB
Loading

.gitbook/assets/image (2).png

41.3 KB
Loading

.gitbook/assets/image (3).png

-21.7 KB
Loading

.gitbook/assets/image (4).png

-88.8 KB
Loading

.gitbook/assets/image (5).png

49.3 KB
Loading

.gitbook/assets/image (6).png

-11.5 KB
Loading

.gitbook/assets/image (7).png

150 KB
Loading

.gitbook/assets/image.png

21.7 KB
Loading

README.md

+39-45
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,52 @@
1-
# Angular Full-Stack generator
2-
[![generator-angular-fullstack](https://angular-fullstack.github.io/assets/angular-fullstack-logo.svg)](https://awk34.gitbook.io/generator-angular-fullstack)
3-
4-
![Build Status](https://img.shields.io/circleci/project/angular-fullstack/generator-angular-fullstack/master.svg)
5-
[![npm version](https://img.shields.io/npm/v/generator-angular-fullstack.svg)](https://www.npmjs.com/package/generator-angular-fullstack)
6-
[![Dependency Status](https://img.shields.io/david/angular-fullstack/generator-angular-fullstack.svg)](https://david-dm.org/angular-fullstack/generator-angular-fullstack)
7-
[![Dev-Dependency Status](https://img.shields.io/david/dev/angular-fullstack/generator-angular-fullstack.svg)](https://david-dm.org/angular-fullstack/generator-angular-fullstack#type=dev)
8-
[![Gitter chat](https://img.shields.io/gitter/room/angular-fullstack/generator-angular-fullstack.svg)](https://gitter.im/angular-fullstack/generator-angular-fullstack)
9-
> Yeoman generator for creating MEAN/SEAN stack applications, using ES2017, MongoDB/SQL, Express, Angular, and Node - lets you quickly set up a project following best practices.
1+
# The Angular Full-Stack Generator
2+
3+
![](.gitbook/assets/angular-fullstack-logo.svg)
104

5+
![Build Status](https://img.shields.io/circleci/project/angular-fullstack/generator-angular-fullstack/master.svg) [![npm version](https://img.shields.io/npm/v/generator-angular-fullstack.svg)](https://www.npmjs.com/package/generator-angular-fullstack) [![Dependency Status](https://img.shields.io/david/angular-fullstack/generator-angular-fullstack.svg)](https://david-dm.org/angular-fullstack/generator-angular-fullstack) [![Dev-Dependency Status](https://img.shields.io/david/dev/angular-fullstack/generator-angular-fullstack.svg)](https://david-dm.org/angular-fullstack/generator-angular-fullstack#type=dev) [![Gitter chat](https://img.shields.io/gitter/room/angular-fullstack/generator-angular-fullstack.svg)](https://gitter.im/angular-fullstack/generator-angular-fullstack)
116

7+
> Yeoman generator for creating MEAN/SEAN stack applications, using ES2017, MongoDB/SQL, Express, Angular, and Node - lets you quickly set up a project following best practices.
128
13-
#### Generated project:
14-
[![Dependency Status](https://img.shields.io/david/angular-fullstack/angular-fullstack-deps.svg)](https://david-dm.org/angular-fullstack/angular-fullstack-deps)
15-
[![Dev-Dependency Status](https://img.shields.io/david/dev/angular-fullstack/angular-fullstack-deps.svg)](https://david-dm.org/angular-fullstack/angular-fullstack-deps?type=dev)
16-
[![Known Vulnerabilities](https://snyk.io/package/npm/angular-fullstack-deps/badge.svg)](https://snyk.io/package/npm/angular-fullstack-deps)
9+
### Generated project:
10+
11+
[![Dependency Status](https://img.shields.io/david/angular-fullstack/angular-fullstack-deps.svg)](https://david-dm.org/angular-fullstack/angular-fullstack-deps) [![Dev-Dependency Status](https://img.shields.io/david/dev/angular-fullstack/angular-fullstack-deps.svg)](https://david-dm.org/angular-fullstack/angular-fullstack-deps?type=dev) [![Known Vulnerabilities](https://snyk.io/package/npm/angular-fullstack-deps/badge.svg)](https://snyk.io/package/npm/angular-fullstack-deps)
1712

1813
## Usage
1914

2015
Install `yo`, `gulp-cli`, and `generator-angular-fullstack`:
21-
```
16+
17+
```text
2218
npm install -g yo gulp-cli generator-angular-fullstack
2319
```
24-
__Please note__: If you run into trouble compiling native add-ons during the installation, follow [`node-gyp`](https://github.com/nodejs/node-gyp)'s short guide on [required compilation tools](https://github.com/nodejs/node-gyp#installation).
2520

26-
Then, to run your app (make sure the MongoDB daemon is running if you selected Mongo), run the following to start your server:
27-
```sh
21+
**Please note**: If you run into trouble compiling native add-ons during the installation, follow [`node-gyp`](https://github.com/nodejs/node-gyp)'s short guide on [required compilation tools](https://github.com/nodejs/node-gyp#installation).
22+
23+
Then, to run your app \(make sure the MongoDB daemon is running if you selected Mongo\), run the following to start your server:
24+
25+
```bash
2826
npm run start:server
2927
```
28+
3029
and the following to start the Webpack dev server for the front-end:
31-
```sh
30+
31+
```bash
3232
npm run start:client
3333
```
3434

35-
The Webpack server will tell you which port to access the app at (usually http://localhost:8080/).
36-
37-
---
35+
The Webpack server will tell you which port to access the app at \(usually [http://localhost:8080/](http://localhost:8080/)\).
3836

3937
Run `yo angular-fullstack`
40-
```
38+
39+
```text
4140
yo angular-fullstack
4241
```
4342

44-
**See the [Getting Started](https://angular-fullstack.github.io/get-started/) guide for more information.**
43+
**See the** [**Getting Started**](https://angular-fullstack.github.io/get-started/) **guide for more information.**
4544

4645
## Prerequisites
4746

4847
* MongoDB - Download and Install [MongoDB](https://www.mongodb.com/download-center#community) - If you plan on scaffolding your project with mongoose, you'll need mongoDB to be installed and have the `mongod` process running.
4948
* If you have [Docker](https://www.docker.com/) installed, you can easily run a test database with `docker run -p 27017:27017 --name afs-mongo -d mongo`
50-
* The project's JavaScript is written in ECMAScript 2015. If you're unfamiliar with the latest changes to the specification for JavaScript, check out http://es6-features.org/
49+
* The project's JavaScript is written in ECMAScript 2015. If you're unfamiliar with the latest changes to the specification for JavaScript, check out [http://es6-features.org/](http://es6-features.org/)
5150

5251
## Supported Configurations
5352

@@ -67,52 +66,46 @@ yo angular-fullstack
6766
* Module Systems: `Webpack`
6867
* Markup: `HTML`, `Pug`
6968
* Stylesheets: `CSS`, `Stylus`, `Sass`, `Less`
70-
<!--* Angular Routers: `ngRoute`, `ui-router`-->
7169
* CSS Frameworks: `Bootstrap`
7270
* Option to include `UI Bootstrap`
7371

7472
**Server**
7573

76-
* Scripts: `JavaScript (Babel)`, `TypeScript` (planned)
74+
* Scripts: `JavaScript (Babel)`, `TypeScript` \(planned\)
7775
* Database:
7876
* `None`,
7977
* `MongoDB`, `SQL`
8078
* Authentication boilerplate: `Yes`, `No`
8179
* oAuth integrations: `Facebook`, `Twitter`, `Google`
8280
* Socket.io integration: `Yes`, `No`
8381

84-
8582
## Generators
8683

8784
Available generators:
8885

8986
* App
90-
- [angular-fullstack](https://angular-fullstack.github.io/generators/app/) (aka [angular-fullstack:app](https://angular-fullstack.github.io/generators/app/))
87+
* [angular-fullstack](https://angular-fullstack.github.io/generators/app/) \(aka [angular-fullstack:app](https://angular-fullstack.github.io/generators/app/)\)
9188
* Server Side
92-
- [angular-fullstack:endpoint](https://angular-fullstack.github.io/generators/endpoint)
93-
* Client Side (via [generator-angular-fullstack-component](https://github.com/angular-fullstack/generator-angular-fullstack-component))
94-
- [angular-fullstack:route](https://angular-fullstack.github.io/generators/route)
95-
96-
89+
* [angular-fullstack:endpoint](https://angular-fullstack.github.io/generators/endpoint)
90+
* Client Side \(via [generator-angular-fullstack-component](https://github.com/angular-fullstack/generator-angular-fullstack-component)\)
91+
* [angular-fullstack:route](https://angular-fullstack.github.io/generators/route)
9792
* To be re-updated:
98-
- [angular-fullstack:component](https://angular-fullstack.github.io/generators/component)
99-
- [angular-fullstack:controller](https://angular-fullstack.github.io/generators/controller)
100-
- [angular-fullstack:filter](https://angular-fullstack.github.io/generators/filter)
101-
- [angular-fullstack:directive](https://angular-fullstack.github.io/generators/directive)
102-
- [angular-fullstack:service](https://angular-fullstack.github.io/generators/service)
103-
- [angular-fullstack:provider](https://angular-fullstack.github.io/generators/service)
104-
- [angular-fullstack:factory](https://angular-fullstack.github.io/generators/service)
105-
- [angular-fullstack:decorator](https://angular-fullstack.github.io/generators/decorator)
93+
* [angular-fullstack:component](https://angular-fullstack.github.io/generators/component)
94+
* [angular-fullstack:controller](https://angular-fullstack.github.io/generators/controller)
95+
* [angular-fullstack:filter](https://angular-fullstack.github.io/generators/filter)
96+
* [angular-fullstack:directive](https://angular-fullstack.github.io/generators/directive)
97+
* [angular-fullstack:service](https://angular-fullstack.github.io/generators/service)
98+
* [angular-fullstack:provider](https://angular-fullstack.github.io/generators/service)
99+
* [angular-fullstack:factory](https://angular-fullstack.github.io/generators/service)
100+
* [angular-fullstack:decorator](https://angular-fullstack.github.io/generators/decorator)
106101
* Deployment
107-
- [angular-fullstack:openshift](https://angular-fullstack.github.io/generators/openshift)
108-
- [angular-fullstack:heroku](https://angular-fullstack.github.io/generators/heroku)
109-
102+
* [angular-fullstack:openshift](https://angular-fullstack.github.io/generators/openshift)
103+
* [angular-fullstack:heroku](https://angular-fullstack.github.io/generators/heroku)
110104

111105
## Documentation
112106

113107
Check out our [documentation home page](https://awk34.gitbook.io/generator-angular-fullstack).
114108

115-
116109
## Contribute
117110

118111
See the [contributing docs](https://github.com/angular-fullstack/generator-angular-fullstack/blob/master/contributing.md)
@@ -124,3 +117,4 @@ When submitting an issue, please follow the [Yeoman issue guidelines](https://gi
124117
[BSD license](http://opensource.org/licenses/bsd-license.php)
125118

126119
[![generator-angular-fullstack](https://angular-fullstack.github.io/assets/angular-fullstack-boxes.svg)](https://awk34.gitbook.io/generator-angular-fullstack)
120+

developing/adding-a-route.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ angular.element(document)
5555

5656
Now that we've imported our new Angular module and added it to the dependency list of our root Angular module, we should be able to navigate to `http://localhost:3000/foo` and see our new route:
5757

58-
![](../.gitbook/assets/image%20%285%29.png)
58+
![](../.gitbook/assets/image%20%281%29.png)
5959

6060
It's not a very impressive page right now, but it works.
6161

@@ -94,7 +94,7 @@ export default angular.module('directives.navbar', [])
9494

9595
Easy enough. Now we should see our entry for 'Foo' in our navbar. It should also be highlighted if you're still on the '/foo' route.
9696

97-
![](../.gitbook/assets/image%20%286%29.png)
97+
![](../.gitbook/assets/image%20%284%29.png)
9898

9999
You can read about all the other subgenerators that are available in the [Generators](../Generators) section of the docs.
100100

developing/overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,15 @@ webpack: bundle is now VALID.
8888

8989
And then our default browser should open up to the app:
9090

91-
![](../.gitbook/assets/image%20%283%29.png)
91+
![](../.gitbook/assets/image%20%287%29.png)
9292

9393
Fantastic! We're now up and running with our Full-Stack Angular web application! So what can it do?
9494

9595
## Homepage
9696

9797
Assuming you scaffolded with a back-end database, you should see some 'features'. If you scaffolded with WebSockets, you should see 'x' buttons next to each, and an input box. Try opening two browser windows to the same page side-by-side, and hitting the 'x' on one of the features. You should see the feature get removed on both web pages. Neat! This is because these database object changes are communicated to clients using WebSockets.
9898

99-
![](../.gitbook/assets/image%20%282%29.png)
99+
![](../.gitbook/assets/image%20%285%29.png)
100100

101101
Neat. Let's see what else we can do.
102102

@@ -117,7 +117,7 @@ You should see inputs for an email address and a password. When running your pro
117117

118118
Go ahead and log in with the admin account, so we can see the extra admin bits too. You should then get sent back to the home page, but should notice that the navbar looks a bit different:
119119

120-
![](../.gitbook/assets/image%20%284%29.png)
120+
![](../.gitbook/assets/image%20%282%29.png)
121121

122122
First, at the top right, we see a greeting for our username, a cog icon \(for user settings\), and a logout button. Then, since we're an admin, we see a new 'Admin' state on the navbar. The admin section lists users and allows you to delete them. The user settings page allows you to change your password.
123123

0 commit comments

Comments
 (0)