Skip to content

Commit

Permalink
Make gruntJS installable and workable locally.
Browse files Browse the repository at this point in the history
  • Loading branch information
bijoyanupam committed May 7, 2017
1 parent a2cc1c4 commit d8de6d3
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 14 deletions.
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
indent_style = space
indent_size = 4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/node_modules/
/assets/css/
/assets/js-minified/
/.vscode/
*.log
8 changes: 0 additions & 8 deletions .vscode/settings.json

This file was deleted.

11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Front-end starter kit for automated web development.

## Getting Started
Install [Node.js](https://nodejs.org/).
Remember: You do not need to install Grunt globally. The Grunt commands are run as npm scripts from a local install.

Get this front-end starter kit by git clone or downloading the latest zip file.

Expand All @@ -27,14 +28,14 @@ npm install

Now that the required packages are installed, you are ready to go.

To check your js and scss files for errors using eslint and sasslint, run the following grunt command.
To check your js and scss files for errors using eslint and sasslint, run the following grunt command using npm scripts.
```
grunt
npm run lint
```

Ready to go live? Run the following grunt command.
Ready to go live? Run the following grunt command using npm scripts.
```
grunt build
npm run build
```

## Configuration
Expand All @@ -44,4 +45,4 @@ Check the .eslintignore file. For options, check [eslintignore](http://eslint.or
- Autoprefixer: Check the browserslist file. For options, check [browserslist options](https://github.com/ai/browserslist#config-file)

## Note
I use VS Code editor and have added related settings. You can exclude/delete them if you use a different editor.
EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. For more, please visit: [EditorConfig](http://editorconfig.org/). A .editorconfig file is included with this project. Please use it for linting to work correcttly.
7 changes: 6 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@
"name": "frontend-starter-kit",
"title": "Front-End Starter Kit",
"description": "Front-end starter kit for automated web development",
"version": "1.0.0",
"version": "1.0.1",
"repository": {
"type": "git",
"url": "https://github.com/bijoyanupam/frontend-starter-kit.git"
},
"scripts": {
"lint": "grunt",
"build": "grunt build",
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": {
"name": "Bijoy K. Anupam",
"email": "bijoy.anupam@gmail.com"
Expand Down

0 comments on commit d8de6d3

Please sign in to comment.