You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-7Lines changed: 31 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Make it easier to develop Mendix themes, without the use of [Scout](https://worl
6
6
7
7
The following things need to be installed:
8
8
*[Node.js](https://nodejs.org/en/)
9
-
*[SASS & Compass](http://thesassway.com/beginner/getting-started-with-sass-and-compass)**<-- this is probably not necessary when using gulp-sass, will check this**
9
+
*[SASS & Compass](http://thesassway.com/beginner/getting-started-with-sass-and-compass)**<-- this is probably not necessary when using gulp-sass, we'll verify this later on**
10
10
11
11
If you want to use Grunt:
12
12
*[Grunt client](http://gruntjs.com/getting-started) (you can install this after installing Node using ```npm install grunt-cli -g```)
@@ -23,11 +23,13 @@ Note:
23
23
24
24
2.) Unzip in your project root folder
25
25
26
-
3.) Open a terminal and go to your project root folder
26
+
3.) Open a terminal and go to your project root folder.
27
27
28
-
4.) Install modules using ```npm install```
28
+
_If you do this on Windows and you encounter errors with installing the dependencies, open your CMD or Powershell as Administrator._
29
29
30
-
(To be sure you do not include node dependencies in you team-project, make sure you add the ``node_modules`` folder to your SVN ignore)
30
+
4.) Install dependencies using ```npm install```
31
+
32
+
(**_If you use this for a Teamserver project, make sure you do not include node dependencies in you team-project: add the ``node_modules`` folder to your SVN ignore_**)
31
33
32
34
## Usage
33
35
@@ -36,13 +38,13 @@ Based on your choise between Gulp or Grunt, you have the following options:
36
38
***default**, run from commandline:
37
39
38
40
```bash
39
-
grunt
41
+
grunt
40
42
```
41
43
42
-
or
44
+
or
43
45
44
46
```bash
45
-
gulp
47
+
gulp
46
48
```
47
49
48
50
***dev**, run from commandline:
@@ -63,13 +65,35 @@ The **default** task will check your theme folder (check Gruntfile.js/Gulpfile.j
63
65
64
66
The **dev** task will do the same as default, but it will start your browser through a [Browsersync](http://www.browsersync.io/docs/grunt/) proxy. Any changes that you make in the css files will be automatically injected in your browser. You do not have to manually refresh your browser.
65
67
68
+
## Modifying parameters
69
+
70
+
There are a few parameters that you can change. Open your ``Gruntfile.js`` or ``Gulpfile.js``, you can change these values at the top:
71
+
72
+
* ``sourceStyleFolder```
73
+
* ``deploymentStyleFolder```
74
+
*``proxyAddress``
75
+
76
+
Make sure ``proxyAddress`` is pointed to your local deployment.
77
+
78
+
## Troubleshooting
79
+
80
+
***``npm install`` fails**<br /><br />
81
+
Make sure you have the package.json and Gruntfile.js/Gulpfile.js in your root folder. Also, if there are errors installing (this can happen when you install the Gulp version), make sure you have administrator rights. See point 3 at Installation.
82
+
83
+
***"I started the dev task, but my ``localhost:3000`` keeps loading"**<br /><br />
84
+
Have you pointed to the right local deployment address? Check the proxyAddress in your Gulp-/Gruntfile.js. This should correspond to the address of your local deployment.
0 commit comments