https://github.com/domenicomonaco/minimalist-pugjs-boilerplate

This is minimalist pug.js boilerplate
https://github.com/domenicomonaco/minimalist-pugjs-boilerplate

boilerplate html html-css html5 nodejs pug pugjs scss starter-kit starter-template template-engine template-engine-html

Last synced: about 2 months ago
JSON representation

This is minimalist pug.js boilerplate

• Host: GitHub
• URL: https://github.com/domenicomonaco/minimalist-pugjs-boilerplate
• Owner: domenicomonaco
• License: other
• Fork: true (StartBootstrap/startbootstrap-creative)
• Created: 2022-03-18T11:46:20.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-05-27T09:30:52.000Z (over 2 years ago)
• Last Synced: 2024-09-24T00:02:57.909Z (about 2 months ago)
• Topics: boilerplate, html, html-css, html5, nodejs, pug, pugjs, scss, starter-kit, starter-template, template-engine, template-engine-html
• Language: JavaScript
• Homepage: https://domenicomonaco.it
• Size: 14.3 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# PUGJS Boilerplate

This is a minimalist [pug.js](https://github.com/pugjs/pug) boilerplate based on [Start Bootstrap Creative Theme](https://github.com/StartBootstrap/startbootstrap-creative).

### Sponsored by

[](https://blog.domenicomonaco.it)

[](https://tecnologieperpersone.it)

## Download and Installation

To begin using this template, choose one of the following options to get started:

- [Fork, Clone, or Download on GitHub](https://github.com/domenicomonaco/minimalist-pugjs-boilerplate)

- Clone the repo: `git clone https://github.com/domenicomonaco/minimalist-pugJS-boilerplate.git`

- Install using npm: `npm i`

## Usage

### Basic Usage

After downloading, simply edit the HTML and CSS files included with `dist` directory. These are the only files you need to worry about, you can ignore everything else! To preview the changes you make to the code, you can open the `index.html` file in your web browser.

### Advanced Usage

Clone the source files of the theme and navigate into the theme's root directory. Run `npm install` and then run `npm start` which will open up a preview of the template in your default browser, watch for changes to core template files, and live reload the browser when changes are saved. You can view the `package.json` file to see which scripts are included.

#### npm Scripts

- `npm run build` builds the project - this builds assets, HTML, JS, and CSS into `dist`

- `npm run build:static` copies the files in the `src/static/` directory into `dist`

- `npm run build:assets` copies the files in the `src/assets/` directory into `dist`

- `npm run build:pug` compiles the Pug located in the `src/pug/` directory into `dist`

- `npm run build:scripts` brings the `src/js/scripts.js` file into `dist`

- `npm run build:scss` compiles the SCSS files located in the `src/scss/` directory into `dist`

- `npm run clean` deletes the `dist` directory to prepare for rebuilding the project

- `npm run start:debug` runs the project in debug mode

- `npm start` or `npm run start` runs the project, launches a live preview in your default browser, and watches for changes made to files in `src`

You must have npm installed in order to use this build environment.

## About

**MONK Boilerplate** is an open source starter kit based on the [Bootstrap](https://getbootstrap.com/) framework and [Pug](https://github.com/pugjs/pug) high-performance template engineimplemented with JavaScript previouse formerly known as "Jade"

## Copyright and License

Copyright 2021-2022 Domenico Monaco [https://domenicomonaco.it](https://domenicomonaco.it) Code released under the [MIT](https://github.com/domenicomonaco/minimalist-pugJS-boilerplate/blob/master/LICENSE) license.

*As the previous Fork*

> Copyright 2013-2021 Start Bootstrap LLC. Code released under the [MIT](https://github.com/StartBootstrap/startbootstrap-creative/blob/master/LICENSE) license.

> 

>