From 61e3bedbc02efe638ed805302857efeb011d6875 Mon Sep 17 00:00:00 2001 From: Dustin Rea Date: Fri, 30 Oct 2015 02:20:45 +0000 Subject: [PATCH] Added Gulp Setup and Troubleshooting to docs/0.4.x Removed Obvious Node Install Warning Removed Gulp Build from cloud-foundry.html to be added in 0.5 Added and Cleaned Up Gulp Setup and Troubleshooting to docs/0.4.x --- _includes/docs/0.4.x/gettingstarted.html | 13 ++++++++- _includes/docs/0.4.x/troubleshooting.html | 34 +++++++++++++++++++++-- 2 files changed, 44 insertions(+), 3 deletions(-) diff --git a/_includes/docs/0.4.x/gettingstarted.html b/_includes/docs/0.4.x/gettingstarted.html index ef8a4292c6..92646cd0e4 100644 --- a/_includes/docs/0.4.x/gettingstarted.html +++ b/_includes/docs/0.4.x/gettingstarted.html @@ -30,6 +30,11 @@

Prerequisites

You're going to use the Grunt Task Runner to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm:
$ npm install -g grunt-cli
+
Gulp (Optional)
+
+ You may use the Gulp Task Runner instead of Grunt. You may use Gulp for Live Reload, Linting, and SASS or LESS compilation. +
$ npm install -g gulp
+

Note: Your user might not have the permissions to install package globally, so use a super user or sudo. @@ -81,12 +86,18 @@

Quick Install

bower installcommand to install all the front-end modules needed for the application.

-

Running Your Application

+

Running Your Application with Grunt

After the install process is over, you'll be able to run your application using Grunt, just run grunt default task:

$ grunt
Your application should run on the 3000 port so in your browser just go to http://localhost:3000.

+

Running Your Application with Gulp (Optional)

+

+ After the install process is over, you'll be able to run your application using Gulp, just run gulp default task: +

$ gulp
+ Your application should run on the 3000 port so in your browser just go to http://localhost:3000. +

That's it! your application should be running by now, to proceed with your development check the other sections in this documentation.
If you encounter any problem try the Troubleshooting section. diff --git a/_includes/docs/0.4.x/troubleshooting.html b/_includes/docs/0.4.x/troubleshooting.html index 44f379bd2e..eed2ffc2b2 100644 --- a/_includes/docs/0.4.x/troubleshooting.html +++ b/_includes/docs/0.4.x/troubleshooting.html @@ -23,7 +23,7 @@

Check Node.js and npm Versions

npm version 1.3.x is supported. -

Update npm, Bower or Grunt

+

Update npm, Bower, Grunt, or Gulp

You may find there is a weird error during install like npm's Error: ENOENT, usually updating those tools to the latest version solves the issue.

@@ -50,6 +50,11 @@

Update npm, Bower or Grunt

To update grunt just run this command in the command-line:
$ npm update -g grunt-cli
+
Updating Gulp
+
+ To update gulp just run this command in the command-line: +
$ npm update -g gulp
+

Cleaning npm and Bower cache

@@ -72,7 +77,7 @@

Common Issues

There are some common errors while installing mean:

-
Node is running but AgnularJS application won't load
+
Node is running but AngularJS application won't load
Check to see all your front-end packages were installed. Bower package manager is used to install the front-end package and it will need a .bowerrc file to install the packages in the right location. @@ -88,4 +93,29 @@

Common Issues

Sometimes it can be a local issue or something that we didn't cover, in case you have any further questions please contact us via the community page.

+

Common node-sass, grunt-sass, gulp-sass Issue

+

+ Another common error for applications using SASS revolves around node-sass and grunt-sass or gulp-sass depending on your choice. The error may occur during npm install or when starting the server. +

+
+
Error during install about node-sass, grunt-sass, or gulp-sass
+
+ First uninstall the project and global gulp-sass and grunt-sass modules. +
$ npm uninstall grunt-sass
+$ npm uninstall gulp-sass
+$ npm uninstall -g grunt-sass
+$ npm uninstall -g gulp-sass
+ Next uninstall the global node-sass module. +
$ npm uninstall -g node-sass
+ Install the global node-sass first. Then install the grunt-sass and/or gulp-sass modules. +
$ npm install grunt-sass
+$ npm install gulp-sass
+ Now try the npm install again from the project folder. +
$ npm install
+ If your npm install still fails at this point. Repeat the above steps but use npm rebuild -g after the global node-sass install, but before installing the project grunt/gulp sass modules. +
$ npm rebuild -g
+ As suggested above, you can also try npm update. +
$ npm update -g
+
+