From 71590bb96d0b356bbdf92e5d8909e1f791407c04 Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Thu, 9 Jul 2015 22:21:47 -0400 Subject: [PATCH 1/7] feat(gen):add readme --- app/templates/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 app/templates/README.md diff --git a/app/templates/README.md b/app/templates/README.md new file mode 100644 index 000000000..42cfd68bc --- /dev/null +++ b/app/templates/README.md @@ -0,0 +1,11 @@ +# <%= _.slugify(_.humanize(appname)) %> + +This project was generated with the [Angular Full-Stack Generator](https://github.com/DaftMonk/generator-angular-fullstack) version <%= pkg.version %>. + +## Build & development + +Run `grunt build` for building and `grunt serve` for preview. + +## Testing + +Running `npm test` will run the unit tests with karma. \ No newline at end of file From d9a75a1f43ba73aba8aad8d53a7cf2a3a853d2d9 Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Sat, 11 Jul 2015 18:10:24 -0400 Subject: [PATCH 2/7] feat(gen:readme): add prerequisite section --- app/templates/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/app/templates/README.md b/app/templates/README.md index 42cfd68bc..932712c76 100644 --- a/app/templates/README.md +++ b/app/templates/README.md @@ -2,6 +2,22 @@ This project was generated with the [Angular Full-Stack Generator](https://github.com/DaftMonk/generator-angular-fullstack) version <%= pkg.version %>. +## Getting Started + +### Prerequisites + +- [Node.js and NPM](nodejs.org) >= v0.10.0 +- [Bower](bower.io) (`npm install --global bower`)<% if(filters.sass) { %> +- [Ruby](https://www.ruby-lang.org)<% } if(filters.grunt) { %> +- [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)<% } if(filters.gulp) { %> +- [Gulp](http://gulpjs.com/) (`npm install --global gulp`)<% } if(filters.babel) { %> +- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.coffee) %> +- [CoffeeScript](http://coffeescript.org/) (`npm install -g coffee-script`)<% } if(filters.stylus) %> +- [Stylus](https://learnboost.github.io/stylus/) (`npm install --global stylus`)<% } if(filters.less) %> +- [Less](http://lesscss.org/) (`npm install --global less`)<% } if(filters.mongoose) %> +- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) %> +- [SQLite](https://www.sqlite.org/quickstart.html)<% } %> + ## Build & development Run `grunt build` for building and `grunt serve` for preview. From dac5fe4e7b8b5151f04673820496f36506539645 Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Sat, 11 Jul 2015 21:13:55 -0400 Subject: [PATCH 3/7] docs(gen:readme): remove unnecessary prereqs, install sass w/ ruby --- app/templates/README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/app/templates/README.md b/app/templates/README.md index 932712c76..97e3d01e7 100644 --- a/app/templates/README.md +++ b/app/templates/README.md @@ -8,13 +8,10 @@ This project was generated with the [Angular Full-Stack Generator](https://githu - [Node.js and NPM](nodejs.org) >= v0.10.0 - [Bower](bower.io) (`npm install --global bower`)<% if(filters.sass) { %> -- [Ruby](https://www.ruby-lang.org)<% } if(filters.grunt) { %> +- [Ruby](https://www.ruby-lang.org) and then `gem install sass`<% } if(filters.grunt) { %> - [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)<% } if(filters.gulp) { %> - [Gulp](http://gulpjs.com/) (`npm install --global gulp`)<% } if(filters.babel) { %> -- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.coffee) %> -- [CoffeeScript](http://coffeescript.org/) (`npm install -g coffee-script`)<% } if(filters.stylus) %> -- [Stylus](https://learnboost.github.io/stylus/) (`npm install --global stylus`)<% } if(filters.less) %> -- [Less](http://lesscss.org/) (`npm install --global less`)<% } if(filters.mongoose) %> +- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.mongoose) %> - [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) %> - [SQLite](https://www.sqlite.org/quickstart.html)<% } %> From 36faae661715ecff1c4b9e589531c7266689e1bc Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Sun, 12 Jul 2015 04:23:31 -0400 Subject: [PATCH 4/7] fix(gen:readme): fix prereqs --- app/templates/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/templates/README.md b/app/templates/README.md index 97e3d01e7..4a087e126 100644 --- a/app/templates/README.md +++ b/app/templates/README.md @@ -11,8 +11,8 @@ This project was generated with the [Angular Full-Stack Generator](https://githu - [Ruby](https://www.ruby-lang.org) and then `gem install sass`<% } if(filters.grunt) { %> - [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)<% } if(filters.gulp) { %> - [Gulp](http://gulpjs.com/) (`npm install --global gulp`)<% } if(filters.babel) { %> -- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.mongoose) %> -- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) %> +- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.mongoose) { %> +- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) { %> - [SQLite](https://www.sqlite.org/quickstart.html)<% } %> ## Build & development From 44b5c8fafe086098a6b1cfb54192d54e10d50325 Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Sun, 12 Jul 2015 19:39:31 -0400 Subject: [PATCH 5/7] docs(gen:readme): add git prereq and development running instructions --- app/templates/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/app/templates/README.md b/app/templates/README.md index 4a087e126..bb4def0ce 100644 --- a/app/templates/README.md +++ b/app/templates/README.md @@ -6,6 +6,7 @@ This project was generated with the [Angular Full-Stack Generator](https://githu ### Prerequisites +- [Git](https://git-scm.com/) - [Node.js and NPM](nodejs.org) >= v0.10.0 - [Bower](bower.io) (`npm install --global bower`)<% if(filters.sass) { %> - [Ruby](https://www.ruby-lang.org) and then `gem install sass`<% } if(filters.grunt) { %> @@ -15,10 +16,20 @@ This project was generated with the [Angular Full-Stack Generator](https://githu - [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) { %> - [SQLite](https://www.sqlite.org/quickstart.html)<% } %> +### Developing<% var i = 1; %> + +<%= i++ %>. Run `npm install` to install server dependencies. + +<%= i++ %>. Run `bower install` to install front-end dependencies.<% if(filters.mongoose) { %> + +<%= i++ %>. Run `mongod` in a separate shell to keep an instance of the MongoDB Daemon running<% } %> + +<%= 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. + ## Build & development Run `grunt build` for building and `grunt serve` for preview. ## Testing -Running `npm test` will run the unit tests with karma. \ No newline at end of file +Running `npm test` will run the unit tests with karma. From 4e3b7365251190d3a9af366052ed0c6d093dccf4 Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Sun, 12 Jul 2015 19:44:58 -0400 Subject: [PATCH 6/7] fix(test): add README.md to expected files --- test/test-file-creation.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/test-file-creation.js b/test/test-file-creation.js index bf5f00301..35fe2055c 100644 --- a/test/test-file-creation.js +++ b/test/test-file-creation.js @@ -212,7 +212,8 @@ describe('angular-fullstack generator', function () { 'bower.json', 'karma.conf.js', 'mocha.conf.js', - 'protractor.conf.js' + 'protractor.conf.js', + 'README.md' ]); /* Ui-Router */ From 263e89ecd3cbad55766071a29c4b1380a3c8d629 Mon Sep 17 00:00:00 2001 From: Andrew Koroluk Date: Sun, 12 Jul 2015 04:23:31 -0400 Subject: [PATCH 7/7] docs(gen:readme): add README.md Squashed commit: [44b5c8f] docs(gen:readme): add git prereq and development running instructions [36faae6] fix(gen:readme): fix prereqs [dac5fe4] docs(gen:readme): remove unnecessary prereqs, install sass w/ ruby [d9a75a1] feat(gen:readme): add prerequisite section [71590bb] feat(gen):add readme --- app/templates/README.md | 17 ++++++++++++++--- test/test-file-creation.js | 3 ++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/app/templates/README.md b/app/templates/README.md index 97e3d01e7..bb4def0ce 100644 --- a/app/templates/README.md +++ b/app/templates/README.md @@ -6,19 +6,30 @@ This project was generated with the [Angular Full-Stack Generator](https://githu ### Prerequisites +- [Git](https://git-scm.com/) - [Node.js and NPM](nodejs.org) >= v0.10.0 - [Bower](bower.io) (`npm install --global bower`)<% if(filters.sass) { %> - [Ruby](https://www.ruby-lang.org) and then `gem install sass`<% } if(filters.grunt) { %> - [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)<% } if(filters.gulp) { %> - [Gulp](http://gulpjs.com/) (`npm install --global gulp`)<% } if(filters.babel) { %> -- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.mongoose) %> -- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) %> +- [Babel](https://babeljs.io) (`npm install --global babel`)<% } if(filters.mongoose) { %> +- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`<% } if(filters.sequelize) { %> - [SQLite](https://www.sqlite.org/quickstart.html)<% } %> +### Developing<% var i = 1; %> + +<%= i++ %>. Run `npm install` to install server dependencies. + +<%= i++ %>. Run `bower install` to install front-end dependencies.<% if(filters.mongoose) { %> + +<%= i++ %>. Run `mongod` in a separate shell to keep an instance of the MongoDB Daemon running<% } %> + +<%= 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. + ## Build & development Run `grunt build` for building and `grunt serve` for preview. ## Testing -Running `npm test` will run the unit tests with karma. \ No newline at end of file +Running `npm test` will run the unit tests with karma. diff --git a/test/test-file-creation.js b/test/test-file-creation.js index bf5f00301..35fe2055c 100644 --- a/test/test-file-creation.js +++ b/test/test-file-creation.js @@ -212,7 +212,8 @@ describe('angular-fullstack generator', function () { 'bower.json', 'karma.conf.js', 'mocha.conf.js', - 'protractor.conf.js' + 'protractor.conf.js', + 'README.md' ]); /* Ui-Router */