Skip to content

Commit f85298f

Browse files
committed
docs(readme): updated docs on the deploy heroku generator
1 parent c12db5b commit f85298f

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

Diff for: deploy/USAGE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Description:
2-
Creates a Heroku deployment folder and grunt configuration
2+
Initalizes a heroku app and generates a `dist` folder which is ready to push to heroku.
33

44
Example:
55
yo angular-fullstack:deploy heroku
66

77
This will create:
8-
heroku deployment folder
8+
a dist folder and initialize a heroku app

Diff for: readme.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Featuring:
1515

1616
Generated by saying yes to all questions: http://fullstack-demo.herokuapp.com/.
1717

18-
> Note: Demo is running on heroku free instance, so you will likely have to refresh for it to load.
19-
2018
Have a look at the source code: https://github.com/DaftMonk/fullstack-demo
2119

2220
## Usage
@@ -110,9 +108,10 @@ Similarly to how the `auth` middleware checks if a user authenticated before goi
110108

111109
## Generators
112110

113-
Available Angular generators:
111+
All of the **generator-angular** client side generators are available, but aliased with `angular-fullstack` to correctly generate with the fullstack folder structure.
112+
113+
Angular sub-generators:
114114

115-
* [angular-fullstack](#app) (aka [angular-fullstack:app](https://github.com/yeoman/generator-angular#app))
116115
* [angular-fullstack:controller](https://github.com/yeoman/generator-angular#controller)
117116
* [angular-fullstack:directive](https://github.com/yeoman/generator-angular#directive)
118117
* [angular-fullstack:filter](https://github.com/yeoman/generator-angular#filter)
@@ -125,23 +124,26 @@ Available Angular generators:
125124
* [angular-fullstack:decorator](https://github.com/yeoman/generator-angular#decorator)
126125
* [angular-fullstack:view](https://github.com/yeoman/generator-angular#view)
127126

128-
Available Fullstack generators:
127+
Fullstack sub-generators:
129128

130129
* [angular-fullstack:deploy](#deploy)
131130

132131
**Note: Generators are to be run from the root directory of your app.**
133132

134-
All of the **generator-angular** client side generators are available, but aliased using `angular-fullstack`.
135-
136-
They are aliased to ensure the files they generate are added to the correct folders and that the `index.(html/jade)` is updated properly.
133+
Read more on the angular sub-generators from the offical [generator angular documentation][1]
137134

138-
Read more on them from the offical [generator angular documentation][1]
139-
140-
## Fullstack specific generators
135+
## Fullstack sub-generators
141136

142137
### Deploy
143138
Initalizes a heroku app and generates a `dist` folder which is ready to push to heroku.
144139

140+
To do the same manually, you need to:
141+
142+
1. Build a dist folder
143+
2. Create a Procfile in the dist folder
144+
3. Create a repository: `git init && git add -A && git commit -m "Initial commit"`
145+
4. Create a heroku app: `heroku apps:create && heroku config:set NODE_ENV=production`
146+
145147
Example:
146148
```bash
147149
yo angular-fullstack:deploy heroku

0 commit comments

Comments
 (0)