Frontend Template

Build Setup:

# Download repository:
git clone https://github.com/Fibonacci-Team/frontend-template frontend-template

# Go to the app:
cd frontend-template

# Install dependencies:
npm i

# Server with hot reload at http://localhost:8082/
npm run dev

# Output will be at dist/ folder
npm run build

Project Structure:

src/pug/pages/*.pug - main app PUG
src/assets/scss - put custom app SCSS styles here. Don't forget to import them in index.js
src/assets/css - the same as above but CSS here. Don't forget to import them in index.js
src/assets/img - put images here. Don't forget to use correct path: assets/img/some.jpg
src/assets/svg - put svg here. Don't forget to use correct path: assets/svg/sprite.svg#id
src/js/modules - put custom app scripts here
src/index.js - main app file where you include/import all required libs and init app
src/components - folder with custom .vue components
src/store - app store for vue
static/ - folder with extra static assets that will be copied into output folder

Settings:

Main const:

Easy way to move all files. Default:

const PATHS = {
  // Path to main app dir
  src: path.join(__dirname, '../src'),
  // Path to Output dir
  dist: path.join(__dirname, '../dist'),
  // Path to Second Output dir (js/css/fonts etc folder)
  assets: 'assets/'
}

Customize:

Change any folders:

const PATHS = {
  // src must be src
  src: path.join(__dirname, '../src'),
  // dist to public
  dist: path.join(__dirname, '../public'),
  // assets to static
  assets: 'static/'
}

Import Another libs:

Install libs
Import libs in ./index.js

// React example
import React from 'react'
// Bootstrap example
import Bootstrap from 'bootstrap/dist/js/bootstrap.min.js'
import 'bootstrap/dist/js/bootstrap.min.js'

Import only SASS or CSS libs:

Install libs
Go to /assets/scss/modules/
Import libs in node modules

// Sass librarys example:
@import '~swiper/swiper';
@import '~swiper/components/navigation/navigation';
@import '~swiper/components/pagination/pagination';

Import js files:

Create another js module in ./js/modules folder
Import modules in ./js/modules/slider file

// another js file for example
import './modules/slider';

Vue install:

Default: already have

Install vue

npm install vue --save

Init vue index.js:

const app = new Vue({
  el: '#app'
})

Create div id app

<div id="app">
  <!-- content -->
</div>

Vuex install:

Install vuex

npm install vuex --save

Import Vuex

import store from './store'

Create index.js in ./store

import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)

export default new Vuex.Store({
  // vuex content
})

Add Vue Components:

Create your component in /components/

HTML Usage:

Init component in index.js:

Vue.component('example-component', require('./components/Example.vue').default)

Any html files:

 <example-component />

VUE Usage:

import components in .vue:

import example from '~/components/Example.vue'

  components: {
    example
  }

Init in vue component:

<example />

PUG Dir Folder

Default

.pug dir: ./src/pug
Configurations: in ./build/webpack.base.conf.js

const PAGES_DIR = PATHS.src

Usage: All files must be created in the ./src/pug folder. Example:

./src/pug/pages/index.pug
./src/pug/pages/about.pug

Pug files structure

layouts/ - Page layout variants. Default - default.pug.
elements/ - Universal, non-customizable markup, which can be used in multiple places.
components/ - Mixins: reusable and customizable markup. Usually these are: quotes, blog posts etc. Included only where used.
components/utils.pug - Universal, context-independent reusable mixins. Included on every page.
sections/ - Contains sections, that are used multiple times in project. Allows minor customization if necessary. If components are used in a section, they must be included in the section, not on the page.
pages/ - Website pages.
functions/ - Pug/JS functions. Due to poor js functions in pug files formatting, would be better to write each function in separate file and include it in main function file - functions.pug.

Create Another Pug Files:

Default:

Automatic creation any pug pages:

Create another pug file in ./src/pug/pages (main folder)
Open new page http://localhost:8082/about.html (Don't forget to RERUN dev server)

SVG Sprites

Import svg files

Automatic creation sprite:

Add .svg file in ./src/assets/svg
Run dev server (You don't need to RERUN dev server)

Usage in Pug

+svg('to-top', 20, 20, 'to-top')

More about mixin look in ./src/pug/utils/mixins.pug

Result in HTML

<svg width="20" height="20" class="to-top">
    <use xlink:href="assets/svg/sprite.svg#to-top"></use>
</svg>

Linters

It is not necessary to change validation rules manually, it is better to discuss it together and make a general decision.

Along with the validation, the autofix is started - everything that can be corrected by the linter in automatic mode.

Style validation (stylint)

Validation rules are described in .stylelintrc.json

How to add an exception for a validator

Examples:

#id {
  color: pink !important; /* stylelint-disable-line declaration-no-important */
}

/* stylelint-disable */
a {}
/* stylelint-enable */

#id {
  /* stylelint-disable-next-line declaration-no-important */
  color: pink !important;
}

Javascript validation (eslint)

Validation rules are described in .eslintrc.json

How to add an exception for a validator

Examples:

alert('foo'); /* eslint-disable-line no-alert */

/* eslint-disable */
alert('foo');
/* eslint-enable */

/* eslint-disable no-alert, no-console */
alert('foo');
console.log('bar');
/* eslint-enable no-alert, no-console */

TODO template improvements

DONE:

License

MIT