Skip to content

Commit 9db44ac

Browse files
committed
Merge pull request angular-fullstack#1063 from DaftMonk/gen-readme
feat(gen): add README.md
2 parents ceb9c64 + f07b09c commit 9db44ac

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

Diff for: app/templates/README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# <%= _.slugify(_.humanize(appname)) %>
2+
3+
This project was generated with the [Angular Full-Stack Generator](https://github.com/DaftMonk/generator-angular-fullstack) version <%= pkg.version %>.
4+
5+
## Getting Started
6+
7+
### Prerequisites
8+
9+
- [Git](https://git-scm.com/)
10+
- [Node.js and NPM](nodejs.org) >= v0.10.0
11+
- [Bower](bower.io) (`npm install --global bower`)<% if(filters.sass) { %>
12+
- [Ruby](https://www.ruby-lang.org) and then `gem install sass`<% } if(filters.grunt) { %>
13+
- [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)<% } if(filters.gulp) { %>
14+
- [Gulp](http://gulpjs.com/) (`npm install --global gulp`)<% } if(filters.babel) { %>
15+
- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.mongoose) { %>
16+
- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) { %>
17+
- [SQLite](https://www.sqlite.org/quickstart.html)<% } %>
18+
19+
### Developing<% var i = 1; %>
20+
21+
<%= i++ %>. Run `npm install` to install server dependencies.
22+
23+
<%= i++ %>. Run `bower install` to install front-end dependencies.<% if(filters.mongoose) { %>
24+
25+
<%= i++ %>. Run `mongod` in a separate shell to keep an instance of the MongoDB Daemon running<% } %>
26+
27+
<%= i++ %>. Run <% if(filters.grunt) { %>`grunt serve`<% } if(filters.grunt && filters.gulp) { %> or <% } if(filters.gulp) { %>`gulp serve`<% } %> to start the development server. It should automatically open the client in your browser when ready.
28+
29+
## Build & development
30+
31+
Run `grunt build` for building and `grunt serve` for preview.
32+
33+
## Testing
34+
35+
Running `npm test` will run the unit tests with karma.

Diff for: test/test-file-creation.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,8 @@ describe('angular-fullstack generator', function () {
212212
'bower.json',
213213
'karma.conf.js',
214214
'mocha.conf.js',
215-
'protractor.conf.js'
215+
'protractor.conf.js',
216+
'README.md'
216217
]);
217218

218219
/* Ui-Router */

0 commit comments

Comments
 (0)