koodiklinikka/gulp-project-template
1
0
Fork 0
mirror of https://github.com/koodiklinikka/gulp-project-template.git synced 2026-02-15 03:52:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Riku Rouvila
2015-01-26 17:10:18 +02:00
parent 0f637fabd4
commit 9bcdd014fb
1 changed files with 7 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -2,10 +2,8 @@
<img width="114px" height="257px" align="right" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"/> <img width="114px" height="257px" align="right" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"/>
### What it does ### What it does
* [Jade](http://jade-lang.com) files to HTML * Bundles all JavaScript with [browserify](http://browserify.org/)
* [Stylus](http://learnboost.github.io/stylus) files to CSS * Minifies HTML and CSS
* [JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) files to Javascript through [browserify](http://browserify.org/)
* You are able to use 'require' in your client-side code
* Serves your static files to localhost:9001 * Serves your static files to localhost:9001
* Reloads your browser with LiveReload when files change * Reloads your browser with LiveReload when files change
@@ -13,12 +11,12 @@
- Install [Node.js](http://nodejs.org) - Install [Node.js](http://nodejs.org)
``` ```
git clone git@github.com:leonidas/gulp-project-template.git <your project name> git clone git@github.com:koodiklinikka/gulp-project-template.git <your project name>
cd <your project name> cd <your project name>
npm install npm install
npm start npm start
open http://localhost:9001 in your browser open http://localhost:9001 in your browser
```` ```
### Enable LiveReload ### Enable LiveReload
Install [LiveReload for Chrome](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en) Install [LiveReload for Chrome](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)
@@ -27,6 +25,8 @@ Install [LiveReload for Chrome](https://chrome.google.com/webstore/detail/livere
* Installs server-side dependencies from NPM and client-side dependencies from Bower * Installs server-side dependencies from NPM and client-side dependencies from Bower
* npm start * npm start
* Compiles your files, starts watching files for changes, serves static files to port 9001 * Compiles your files, starts watching files for changes, serves static files to port 9001
* npm test
* Runs all tests
* npm run build * npm run build
* Builds everything * Builds everything
@@ -37,25 +37,4 @@ Minification, uglification and other tasks you're expected to run before deployi
## Development guidelines ## Development guidelines
* **public** - directory should be dedicated only to compiled/copied files from **src** - directory. * **public** - directory should be dedicated only to compiled/copied files from **src** - directory.
It should be possible to delete directory completely and after **npm start** or **npm run build** everything should be as they were before the deletion. It should be possible to delete directory completely and after **npm start** or **npm run build** everything should be as they were before the deletion.
* All backend dependencies should be installed with **npm**. Browser dependencies should be installed with **bower** or with **npm**. * All development dependencies should be installed with **npm**. Browser dependencies should be installed with **bower** or with **npm**.
### Using JavaScript instead of CoffeeScript
Remove coffeeify transform from package.json file (browserify.transform field)
```diff
"transform": [
- "coffeeify",
"debowerify",
"deamdify"
]
```
and change the ".coffee" extension to ".js" from gulpfile.coffee
```diff
config =
scripts:
- source: './src/coffee/main.coffee'
- extensions: ['.coffee']
+ source: './src/js/main.js'
+ extensions: ['.js']
```
You also can change the directory name to scripts or what ever.