mrDinckleman / gulped

Project template based on SASS and EJS builded with Gulp

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Gulped devDependency Status

Project template based on SASS and EJS bundled by Gulp

Make HTML markup easily with this project template.

Follows the Airbnb JavaScript Style Guide.

Technologies

Views

  • gulp-ejs for creating static html-pages
  • gulp-data for filling ejs-templates with data from json-files

Styles

Scripts

Images

Development

File structure

.
├── app               # Source files
│   ├── fonts         # Fonts
│   ├── images        # Images
│   ├── js            # JS files
│   ├── scss          # SCSS files
│   ├── static        # Static files
│   └── views         # EJS files
├── public            # Compiled files
│   └── assets
│       ├── css       # CSS files
│       ├── images    # Images
│       ├── fonts     # Fonts
│       └── js        # JS files
└── release           # ZIP-archives with compiled files

Usage

Install Node.js.

Install Gulp CLI:

$ npm install gulp-cli -g

Clone repo and install dependencies:

$ git clone https://github.com/mrDinckleman/gulped project
$ cd project
$ npm install

Change name, version, homepage and author information in package.json because they appear in banner.

Then run npm run start to run the project. A new browser window will open with a BrowserSync server showing the finished files.

Run npm run build for building version for production.

Commands npm run styles and npm run scripts build production versions for styles and script respectively.

Views

To add global template data, specify it in app/views/global.json.

To add new template like page.ejs, place it to the app/views directory. You can add associated data to page.json.

Scripts

To add vendor scripts, just import it in app/scripts/app.js like:

import $ from 'jquery';

Static

Files, placed in app/static directory will be copied to the root of public directory. Use it for favicon, robots.txt or other similar files.

About

Project template based on SASS and EJS builded with Gulp

License:MIT License


Languages

Language:JavaScript 88.9%Language:EJS 7.5%Language:SCSS 3.6%