8000 GitHub - techpaf/web-starter: A simple starter for web projects
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

techpaf/web-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

alt text

WEB STARTER

A simple starter for small web projects

Hello there, here is a tiny starter we've build to answer our own needs.

What's inside the box ?

Documentation (sort of...)

Setup :

  • Clone that repo on your computer
  • In a shell cd to where you cloned the git
  • Run npm install
  • Run gulp (by default this executes the 'watch' task)
  • You're ready to start coding

Start coding :

  • You have to work inside app/ (all your src must be inside)
  • Your HTML must be written inside app/index.html
  • Your CSS must be written inside app/scss/style.scss
  • Your JS must be written inside app/js/main.js
  • Your images must be placed inside app/img/

Gulp is in charge of :

  • Running a web server / livereload
  • Compiling Sass stuff
  • Minifying & uglifying CSS / JS files
  • Optimizing images

Gulp tasks :

  • gulp watch
    • Start the web server
    • Open page in browser
    • Handle livereload
    • Watch files
    • Compile SaSS...
  • gulp build
    • Clean the dist/
    • Compile SaSS
    • Take all link tags inside html file and build a file single file
    • Take all script tags inside html file and build a file single file
    • Copy HTML / CSS / JS files inside dist
    • Optimize image from app/img/, then copy to dist/img
  • gulp quick-build
    • same as gulp build, but without minifying image

Under the hood :

  • The watch task will watch change on .html .scss and .js files
  • Never edit your CSS in app/css/style.css, file is erased each time SaSS compiled
  • app/css/main.css & app/css/normalize.css are CSS from HTML5Boilerplate
  • app/js/plugins.js & app/js/vendors/modernizr-$.min.js are JS from HTML5Boilerplate

Credits :

  • HTML5Boilerplate because it's my favorite boilerplate
  • Node because that's my favorite tool ATM
  • Gulp because it's faster than Grunt and Gulp sound better than Grunt
  • SaSS because it saved me a lot of time
  • CSSTricks for some cool articles on Gulp and more generaly this website rocks

About

A simple starter for web projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0