alexseif / friendkit

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Friendkit | Social Media UI kit 2.3

Note

Changes should be commited to src/ files only.

How to use

The template is built with Sass and Gulp build system with these features:

  • Handlebars HTML templates with Panini– Panini is a super simple flat file generator for use with Gulp. It compiles a series of HTML pages using a common layout. These pages can also include HTML partials, external Handlebars helpers, or external data as JSON.
  • Sass compilation, prefixing with Autoprefixer, and JavaScript concatenation
  • Built-in BrowserSync server - Will automatically reload your page when files are changed. It also live-injects CSS changes when you save a Sass file. This task runs continuously. Defaults to localhost.
  • For production builds - CSS compression, JavaScript compression, Image compression and more..

Requirements

To use this template, your computer needs:

  • Node.js is used to run the build processes. https://nodejs.org/en/download/
  • Test: run node -v in the terminal
  • Npm (Node comes with npm installed so you should have a version of npm.) Used to manage development dependencies.
  • Test: run npm -v in the terminal
  • Gulp – task runner npm install -g gulp
  • Test: run gulp -v in the terminal

Installing:

  • Install all node packages: npm install (or yarn install --ignore-engines)
  • Run gulp dev
  • Your site is now viewable at this URL: http://localhost:3000

Folder Structure:

  • dist/ - compiled distribution files
  • node_modules - front-end dependencies
  • src/ - contains all of your core, working files—static assets, pages, templates, etc
  • src/assets/ - scss files, JS files, images, and fonts are here
  • src/data/ - external data
  • src/layouts/ - HTML layouts templates
  • src/pages/ - site pages
  • src/partials/ - handlebars partials files.
  • gulpfile.js - all task definitions
  • package.json - handles the front-end dependencies
  • .htmllintrc - handles the HTML lint rules
  • .sass-lint.yml - handles the SCSS lint rules
  • reports - txt generated file for accessibility issues

Gulp Plugins:

Additional Resources:

About

License:Other


Languages

Language:HTML 66.4%Language:SCSS 24.1%Language:JavaScript 6.6%Language:Sass 2.9%Language:Dockerfile 0.0%