miw-t-uwu-t-pub.id/README.md

Website blueprint

Blueprint to build a simple website

Features

HTML

Basic index.html file

CSS

• Preprocessor: SASS
• Naming conventions: BEM
• Code structure: inspired by SMACSS

./css/scss
  style.scss        // imports of all styles

  /base             // general styles, font-face, helpers
  /layout           // styles defining the layout of the page
  /modules          // independent modules, that can be re-used

JavaScript

• TypeScript support
• Modular JS (imports & exports)

./js
  script.ts         // imports all necessary TS files

  /modules          // re-usable modules as classes

Tools

Taskrunner

gulp, different tasks are defined within the gulptasks folder.

Available tasks:

gulp                // default task for development (build dist and watch src)
build               // production ready build in dist

assets              // copy assets folder
clean               // clean dist folder
html                // move .html files to dist
styles              // compile SASS
webpack             // compile TypeScript
watch               // watch src and handle changed files

Webpack

Typescript is compiled and bundled with webpack. Config: webpack.config.js

Linter & formatter

eslint to find and fix problems within JavaScript and prettier to format code.

configs:

.eslintignore
.eslintrc.json
.prettierrc

npm scripts:

lint
lint:fix

---

Installation

Prerequisite: Have node.js and npm installed.

1. Clone or download this repository
2. Install dependencies

npm install

---

Usage

1. Start watcher npm run dev
2. Make changes within the src folder
3. Generated files will be in dist

Deploy for production

npm run build

---

License

MIT License