4.0.13 • Published 4 years ago

frontkit v4.0.13

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

Frontkit NPM version NPM dependiencies

Frontkit is static site generator. It consists of very opinionated Gulp workflow (with support of modern web tools like Browserify, JavaScript ES6 support, CSS preprocessors, file minificators, image optimizers) and basic directories & files structure that is generated during each project initialization. It was created mainly for my personal use, but if you like it and are keen to use it—I'll be more than happy if you do.

I bet above description haven't been very helpful in understanding what Frontkit actually does, so let's see how to use it.

Usage

First step is to install the package globally.

npm install -g frontkit

Now that you have it installed, you can initialize new project.

frontkit new project-name "Project Name"
cd project-name
npm install
gulp

Above commands will create project-name directory and copy project files there. Next, cd to this newly created directory and run npm install to install all dependencies, and start up the Gulp workflow using gulp. And yeah, that's it—you're ready to rock! :metal:

Second parameter—name of the project—is optional. If not provided, "Project Name" will be inserted into project README.md file and in <title></title>.

For reference, below is list of all tasks and options that you can pass to your Gulp.

# This task will watch for changes in files and recompile them as needed.
gulp watch

# Recreate whole project.
gulp build

# Equivalent of 'gulp build && gulp watch'.
gulp

# Running any task with 'dev' parameter with skip time-consuming tasks
# like file minification (JS, CSS) and image optimization. It's helpful
# during development process.
gulp --dev
gulp build --dev
gulp watch --dev

# Deploy changes to defined host (see Configuration section further in this
# document).
gulp deploy --target=production

Structure

During project creation, Frontkit will create below structure of files in project directory.

.
├── node_modules/
├── src/
│   ├── templates/
│   ├── scripts/
│   ├── styles/
│   ├── images/
│   ├── icons/
│   ├── sprites/
│   ├── files/
├── .editorconfig
├── .gitignore
├── .jshintrc
├── gulpfile.js
└── package.json

I bet you already know what all the files in root directory do (yeah, just pre-configured files for linting, syntax formatting, etc.), so in the next section we'll focus on the contents of src directory.

Tasks

Frontkit src folder consists of six main directories (these have their equivalents as Gulp tasks.) Let's find out what kind of stuff can be put to each of them and what will happen if you do this.

templates

HTML files compiled using Twig template engine. Thanks to Twig, templates can be divided into partials and later included in main HTML files. Partials (files with _ prefix in their name) will not be copied to compiled target. Frontkit uses Twig.js which means you can use basically all the functionalities from its original PHP implementation. At the end, files are prettified with JS Prettify library to ensure consistency in the output.

scripts

Directory with JavaScript files. Frontkit has Browserify support built in, so you can use it out of the box. You can also write JS code using ECMAScript 6 as it's also supported by default.

styles

Place for CSS, SCSS and Sass files. SCSS and Sass files are compiled to regular CSS files with libsass. You can use wildcard to import all the files from given directory:

@import 'blocks/*' // Will import all the files in the blocks folder.

Each compiled file will be automatically minified and named with .min suffix.

images

Images used strictly for layout purposes. Will be optimized using gulp-imagemin.

icons

SVG files from which font will be generated.

sprites

Thanks to gulp-svgstore, you can combine multiple SVG files into one that can be later used to embed inline SVG shapes in your HTML. Just create directory in /sprites and put SVG files in there. During build process, all files inside this directory will be combined into one with the same name. If you, for example, have sprites/sprite-name/icon-name.svg, you'll be able to embed it with below code.

<svg>
  <use xlink:href="images/sprite-name.svg#icon-name"></use>
</svg>

files

Other static files that will be copied to the root of target directory. This is useful for archives, PDFs, etc.

Configuration

gulpfile.js created in your project directory is pre-configured but you can always change it to change behavior of Frontkit.

// gulpfile.js
require('frontkit')(require('gulp'), {
  // Directory where all source files are stored.
  "source": "src",

  // List of all targets where Frontkit will compile source files.
  // You can also specify which tasks will be invoked for each target.
  "targets": [
    {
      "path": "dist",
      "tasks": [
        "templates",
        "scripts",
        "styles",
        "images",
        "icons",
        "sprites",
        "files"
      ]
    }
  ],

  // For configuration of deploy functionality, read "deploy" section below.
  "deploy": {}
})

targets

Array of directories to which source will be compiled. path points to target directory, tasks is array of performed tasks.

deploy

You can define one or more deploy targets, each with its own set of configuration options. You can choose of three adapters: vinyl-ftp, gulp-scp2 and rsync-slim. Each of them have different set of configuration options.

To use vinyl-ftp, set value of adapter to "ftp". To configure this adapter, look into documentation of the package. There are also two additional properties: files (path to local files) and destination (remote directory on the server). Example configuration:

"deploy": {
  // ...
  "staging": {
    "adapter": "ftp",
    "host": "staging.domain.com",
    "user": "staging",
    "password": "letmein",
    "destination": "/var/www/staging.domain.com",
    "files": ["dist/**/*", "!dist/.git/"]
  },
  // ...
}

To use gulp-scp2, set value of adapter to "scp2" and pass package configuration (look into documentation). There is also one additional property: files - path to local files. Example configuration:

"deploy": {
  // ...
  "preview": {
    "adapter": "scp2",
    "port": 22,
    "host": "domain.com",
    "dest": "/var/www/domain.com",
    "files": ["dist/**/*", "!dist/.git/"]
  },
  // ...
}

Using rsync-slim is also easy. Set value of adapter to "slim" and pass package configuration (look into documentation).

"deploy": {
  // ...
  "preview": {
    "adapter": "slim",
    "src": ["dist"],
    "dest": "user@domain.com:/path/on/server",
    "options": "-rtvhcz --delete --progress"
  },
  // ...
}

Requirements

The following software needs to be installed before using Frontkit. These installations need to be done just once so you can skip this section if you have the software already installed.

First is Node.js, so you can work with npm, Node package manager. You can install it from pre-built installer or using Homebrew:

brew install node

Then install Gulp globally:

npm install -g gulp

License

Frontkit is open-sourced software licensed under the MIT license.