Skip to content

lekomtsev/jsmaster-start-template

Repository files navigation

HTML Starter

Webpack

Kick-start your project, this boilerplate based Webpack

Features

  • Live reloading
    browser update after changes
  • Automatically optimizes entry files
    concatenate, minify and inject output files to HTML
  • Sass for stylesheets
    with the 7-1 Pattern
  • Modern JavaScript
    ES6 modules-based code linting by ESLint
  • Older browsers support
    • add vendor prefixes in CSS with Autoprefixer
    • convert ES6+ code into a backwards compatible with Babel
  • Includes:
  • sourceMaps
  • and more...

Theme development

Node.js is the only required dependency to work with HTML Starter.

Installation

  1. Install Node.js (installation depends on your system). After finishing, you will be able to check the version number using node -v and npm -v commands (npm is distributed with Node.js).
  2. Clone the repo using git clone [email protected]:lekomtsev/jsmaster-start-template.git.
  3. Open folder jsmaster-start-template (command: cd jsmaster-start-template) and install a packages of HTML Starter via npm install command.

Now you have everything you need to run the build process.

Build commands

  • npm run start ─ compile assets when file changes are made, start webpack-dev-server session
  • npm run build ─ compile and optimize (the files in your assets directory) for production

Structure

Shorten directories and files structure which you'll see after build:

jsmaster-start-template/
├── assets/                 # template assets
│   ├── fonts/              # place template fonts files here
│   ├── html/               # template HTML files
│   │  ├── partials/        # common parts of HTML code
│   │  │  └── [...]
│   │  ├── 404.html         # placeholder 404 error page
│   │  └── index.html       # default HTML skeleton
│   ├── images/             # template images files
│   │  └── [...]
│   ├── scripts/            # template javascript files
│   │  ├── vendor/          # necessary parts of frameworks and libs
│   │  │  └── [...]         # Bootstrap, FontAwesome, jQuery
│   │  └── main.js          # main javascript file that references JS source files
│   ├── scss/               # template styles
│   │  ├── [...]            # Sass architecture folders
│   │  └── main.scss        # main Sass file that references scss source files
│   ├── index.js            # entry point of template
│   └── [...]               # miscellaneous
├── dist/                   # output folder with production build (don't edit)
│   ├── css/                # output styles
│   ├── images/             # output images
│   ├── js/                 # output javascripts
│   ├── index.html          # homepage
│   └── [...]               # miscellaneous
├── node_modules/           # Node.js packages (don't edit)
│   └── [...]
├── .babelrc                # Babel configuration file
├── .eslintrc.js            # ESLint configuration file
├── .stylelintrc            # Stylelintrc configuration file
├── package.json            # Node.js dependencies and scripts
├── webpack.config.js       # Webpack configuration file
├── package-lock.json       # Node.js dependencies lock file (don't edit)
└── [...]                   # other...

Demo

Simple real estate website

About

HTML start template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published