/frontend-starter-kit

Minimal frontend only boilerplate that includes zurb panini, postcss, babel and gulp.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

frontend-starter-kit

Minimal frontend only boilerplate with gulp, zurb panini, postcss and babel.

The following packages are required to run the project:

  • node js
  • npm

Available Commands

Open command window and navigate to project's folder root(where 'gulpfile.bebel.js' and 'package.json' files are located). There we can execute the following commands:

Command Description
npm install This command download all gulp dependencies and store them in 'node_modules' folder. We execute this command only once, when we start new the project.
npm start This command create background process that watches all source files for changes compile them in '/dist' folder. We execute this command only once before we start making changes in source files.
npm run assets Clean assets folder and update the content in it.
npm run build Command that build static pages, compile, copy and minify resources.
npm run serve Optional simple server that is serving /dist folder on localhost:8080 by default.

What should I do first

  • Clone the project.
$ git clone <REPO_URL>
  • Delete .git folder.
$ rm -rf .git/
  • Build static pages for the first time(creates 'dist' folder).
$ npm run build
  • Start work on your project.
$ npm start

Folder structure:

<PROJECT_ROOT>
  └─src
    └─markup    # html partials
    └─styles    # css source files
    └─scripts   # js source files
  └─dist
    └─markup    # static html
    └─styles    # compiled css
    └─scripts   # compiled js