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
+35-5Lines changed: 35 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ JavaScript Boilerplate is the collection of best practices using a design patter
6
6
## Files in Repository
7
7
8
8
9
-
1.`src/index.html` - An html help file illustrating helper functions.
9
+
1.`src/index.html` - An html help file illustrating helper functions.
10
10
11
-
2.`src/js/_config.js` - Config is having general details that will be commonly used across the application. Parameters like URLs, services, theme to be used within the application.
11
+
2.`src/js/_config.js` - Config is having general details that will be commonly used across the application. Parameters like URLs, services, theme to be used within the application.
12
12
13
-
3.`src/js/_helper.js` - Helper utility functions that are required across different modules or even within a single module.
13
+
3.`src/js/_helper.js` - Helper utility functions that are required across different modules or even within a single module.
14
14
15
-
4.`src/js/_main.js` - It defines the main module. We have used IIFE (Intermediately invoking function expression) namespacing and global abatement in this logic. MODULE is main namespace that has been defined and MODULE.helper is one of the components.
15
+
4.`src/js/_main.js` - It defines the main module. We have used IIFE (Intermediately invoking function expression) namespacing and global abatement in this logic. MODULE is main namespace that has been defined and MODULE.helper is one of the components.
16
16
17
-
5.`src/css/style.css` - Style sheets for the html help file.
17
+
5.`src/css/style.css` - Style sheets for the html help file.
18
18
19
19
## Usage
20
20
@@ -63,6 +63,36 @@ You can also get the JavaScript Boilerplate through npm if you have already inst
63
63
64
64
npm install javascript-boilerplate
65
65
66
+
## Build Instructions
67
+
68
+
### We recommend using Grunt
69
+
70
+
Grunt - Download and Install [Grunt](http://gruntjs.com).
71
+
72
+
OR
73
+
74
+
Install Grunt
75
+
76
+
$ npm install grunt
77
+
78
+
You can also Install all the dependencies using
79
+
80
+
$ npm install
81
+
82
+
### Updating Grunt:
83
+
```
84
+
$ npm update -g grunt-cli
85
+
```
86
+
87
+
### Build the Project using
88
+
89
+
$ grunt
90
+
91
+
You should see the below message for a successful build and a folder name `dist` has been created with all the expected output, parallel to `src` folder, with all the tasks completed.
92
+
93
+
Done, without errors.
94
+
95
+
66
96
## Contributing
67
97
68
98
Anyone and everyone is welcome to [contribute](#).
0 commit comments